KpiCollection.Insert Method (Int32, String, String)

Creates and inserts a Kpi, with the specified name and identifier, into the collection at the specified index.

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

Syntax

'Declaration
Public Function Insert ( _
    index As Integer, _
    name As String, _
    id As String _
) As Kpi
'Usage
Dim instance As KpiCollection 
Dim index As Integer 
Dim name As String 
Dim id As String 
Dim returnValue As Kpi 

returnValue = instance.Insert(index, name, _
    id)

public Kpi Insert(
    int index,
    string name,
    string id
)

public:
Kpi^ Insert(
    int index, 
    String^ name, 
    String^ id
)

member Insert : 
        index:int * 
        name:string * 
        id:string -> Kpi

public function Insert(
    index : int, 
    name : String, 
    id : String
) : Kpi

Parameters

• index
  Type: System.Int32
  The zero-based index at which the new Kpi will be inserted.

• name
  Type: System.String
  The name of the Kpi to be inserted.

• id
  Type: System.String
  The identifier of the Kpi to be inserted.

Return Value

Type: Microsoft.AnalysisServices.Kpi
A new, empty Kpi.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	index is less than zero. -or- index is equal to or greater than [H:Microsoft.AnalysisServices.ModelComponentCollection.Count].

See Also

Reference

KpiCollection Class

Insert Overload

Microsoft.AnalysisServices Namespace