AnnotationCollection.Insert Method (Int32, String, String)

 

Applies To: SQL Server (starting with 2016)

Creates and inserts an Annotation, with the specified name and value, into the collection at the specified index.

Namespace:   Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices.Core (in Microsoft.AnalysisServices.Core.dll)

Syntax

public Annotation Insert(
    int index,
    string name,
    string value
)

public:
Annotation^ Insert(
    int index,
    String^ name,
    String^ value
)

member Insert : 
        index:int *
        name:string *
        value:string -> Annotation

Public Function Insert (
    index As Integer,
    name As String,
    value As String
) As Annotation

Parameters

• index
  Type: System.Int32

  The zero-based index at which the new Annotation will be inserted.

• name
  Type: System.String

  The name of the Annotation to be inserted.

• value
  Type: System.String

  The value of the Annotation to be inserted.

Return Value

Type: Microsoft.AnalysisServices.Annotation

The Annotation inserted into the collection.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	index is less than zero.-or-index is equal to or greater than Count.

See Also

Insert Overload
AnnotationCollection Class
Microsoft.AnalysisServices Namespace

Return to top