KpiCollection.Insert Method

Definition

Namespace:

Microsoft.AnalysisServices

Assembly:

Microsoft.AnalysisServices.dll

Package:

Microsoft.AnalysisServices v19.87.2

Overloads

Insert(Int32, String, String)	Creates a new Kpi object using the specified name and identifier, inserts it to the collection at the specified index and returns the new Kpi created.
Insert(Int32, String)	Creates a new Kpi object using the specified name, inserts it to the collection at the specified index and returns the new Kpi created.
Insert(Int32, Kpi)	Inserts the specified Kpi to the collection at the specified index.
Insert(Int32)	Creates a new Kpi object using a generated unique Name and identifier, inserts it to the collection at the specified index and returns the new Kpi created.

Insert(Int32, String, String)

Creates a new Kpi object using the specified name and identifier, inserts it to the collection at the specified index and returns the new Kpi created.

public Microsoft.AnalysisServices.Kpi Insert (int index, string name, string id);

override this.Insert : int * string * string -> Microsoft.AnalysisServices.Kpi

Public Function Insert (index As Integer, name As String, id As String) As Kpi

Parameters

index

Int32

The zero-based index at which the Kpi is inserted.

name

String

The Name for the new Kpi object.

id

String

The identifier for the new Kpi object.

Returns

Kpi

The newly created Kpi object.

Exceptions

ArgumentOutOfRangeException

The specified index is not a valid value (less than zero or bigger then the total number of elements).

InvalidOperationException

• The specified name is not valid in the collection.
• The specified identifier is not valid in the collection.

Insert(Int32, String)

Creates a new Kpi object using the specified name, inserts it to the collection at the specified index and returns the new Kpi created.

public Microsoft.AnalysisServices.Kpi Insert (int index, string name);

override this.Insert : int * string -> Microsoft.AnalysisServices.Kpi

Public Function Insert (index As Integer, name As String) As Kpi

Parameters

index

Int32

The zero-based index at which the Kpi is inserted.

name

String

The Name for the new Kpi object. It must be unique within the collection.

Returns

Kpi

The newly created Kpi object.

Exceptions

ArgumentOutOfRangeException

The specified index is not a valid value (less than zero or bigger then the total number of elements).

InvalidOperationException

The specified name is not valid in the collection.

Remarks

The identifier for the Kpi is generated based on the specified Name.

Insert(Int32, Kpi)

Inserts the specified Kpi to the collection at the specified index.

public void Insert (int index, Microsoft.AnalysisServices.Kpi item);

override this.Insert : int * Microsoft.AnalysisServices.Kpi -> unit

Public Sub Insert (index As Integer, item As Kpi)

Parameters

index

Int32

The zero-based index at which the Kpi is inserted.

item

Kpi

The Kpi to be inserted.

Exceptions

ArgumentOutOfRangeException

The specified index is not a valid value (less than zero or bigger then the total number of elements).

InvalidOperationException

• The specified item is a null reference (Nothing in Visual Basic).
• The specified item already esists in the collection.
• The identifier of the specified Kpi is not valid in the collection.
• The name of the specified Kpi is not valid in the collection.
• The compatibility-level of the specified Kpi is not valid in the collection.

Insert(Int32)

Creates a new Kpi object using a generated unique Name and identifier, inserts it to the collection at the specified index and returns the new Kpi created.

public Microsoft.AnalysisServices.Kpi Insert (int index);

override this.Insert : int -> Microsoft.AnalysisServices.Kpi

Public Function Insert (index As Integer) As Kpi

Parameters

index

Int32

The zero-based index at which the Kpi is inserted.

Returns

Kpi

The newly created Kpi object.

Exceptions

ArgumentOutOfRangeException

The specified index is not a valid value (less than zero or bigger then the total number of elements).