Function

ABMultiValueCopyLabelAtIndex

Returns the label for the given index.

Declaration

CFStringRef ABMultiValueCopyLabelAtIndex(ABMultiValueRef multiValue, CFIndex index);

Parameters

multiValue

The multi-value list that you wish to access.

index

The index of the identifier you wish to obtain. If this parameter is out of bounds, this function raises an exception.

Return Value

The label at index in multiValue. You are responsible for releasing this object.

Discussion

Each value in a multi-value list must be the same type, and has an associated pre-defined or user-defined label, and unique identifier. Use the ABMultiValueCopyIdentifierAtIndex function to get a identifier, and the ABMultiValueCopyValueAtIndexfunction to get a value.

See Also

Multi Values

ABMultiValueAdd

Adds a value and its label to a multi-value list.

ABMultiValueCopyIdentifierAtIndex

Returns the identifier at the given index.

ABMultiValueCopyPrimaryIdentifier

Returns the identifier for the primary value.

ABMultiValueCopyValueAtIndex

Returns the value for the given index.

ABMultiValueCount

Returns the number of entries in a multi-value list.

ABMultiValueCreate

Returns a new ABMultiValue object.

ABMultiValueCreateCopy

Returns a copy of a multi-value object.

ABMultiValueCreateMutable

Returns a newly created mutable multi-value list object.

ABMultiValueCreateMutableCopy

Returns a mutable copy of a multi-value object.

ABMultiValueIndexForIdentifier

Returns the index for the given identifier.

ABMultiValueInsert

Inserts a value and its label at the given index in a multi-value list.

ABMultiValuePropertyType

Returns the type for the values in a multi-value list.

ABMultiValueRemove

Removes the value and label at the given index.

ABMultiValueReplaceLabel

Replaces the label at the given index.

ABMultiValueReplaceValue

Replaces the value at the given index.

ABMultiValueSetPrimaryIdentifier

Sets the primary value to be the value for the given identifier.