ClaimPropertyIndex Property

Selects a property.

Syntax

 saml.getClaimPropertyIndex(index, [callback])
 saml.setClaimPropertyIndex(index,  claimPropertyIndex, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getClaimPropertyIndex([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setClaimPropertyIndex([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Selects a property. This is valid from 0 to ClaimPropertyCount. To inspect a property, first set this property and then inspect ClaimPropertyName and ClaimPropertyValue. For instance:

for(int i=0;i<component.Claims[0].PropertyCount;i++)
{
    component.Claims[0].PropertyIndex = i;
    Console.WriteLine(component.Claims[0].PropertyName + ": " + component.Claims[0].PropertyValue);
}

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ClaimCount property.

This property is not available at design time.

Data Type

Integer