| Derived from | CFTypeRef |
| Framework | AddressBook/AddressBook.h |
| Declared in | ABMultiValue.h |
The ABMultiValue opaque type (whose objects are known as multivalues) implements a property that can have multiple values. All the contained values must be of the same type. Each value has a unique identifier and a nonunique label, which may be one of the provided labels or one defined by the user.
For example, if a multivalue property is used to store phone numbers, there may be multiple Work phone numbers. These have the same label, but different unique identifiers.
Multivalue properties are immutable. To use mutable multivalue properties, see ABMutableMultiValue Reference.
ABMultiValueCopyValueAtIndex
ABMultiValueCopyArrayOfAllValues
ABMultiValueGetCount
ABMultiValueGetFirstIndexOfValue
ABMultiValueCopyLabelAtIndex
Returns an array with the values in a multivalue property.
CFArrayRef ABMultiValueCopyArrayOfAllValues ( ABMultiValueRef multiValue );
The multivalue property whose values are being return.
Array containing the values in multiValue.
ABMultiValue.hReturns the label for a value in a multivalue property.
CFStringRef ABMultiValueCopyLabelAtIndex ( ABMultiValueRef multiValue, CFIndex index );
The multivalue property with the value whose label to return.
Location of the value within multiValue whose label to return.
Raises an exception when out of bounds.
Label for the value at index within multiValue.
If there is no label for the value at index, returns NULL.
ABMultiValue.hReturns the value at a particular location within a multivalue property.
CFTypeRef ABMultiValueCopyValueAtIndex ( ABMultiValueRef multiValue, CFIndex index );
The multivalue property from which to obtain the value.
Location of the desired value within multiValue.
Raises an exception when out of bounds.
The value at index in multiValue.
ABMultiValue.hReturns the number of values in a multivalue property.
CFIndex ABMultiValueGetCount ( ABMultiValueRef multiValue );
The multivalue property whose value are being counted.
The number of values in multiValue.
ABMultiValue.hReturns the first location of a value in a multivalue property.
CFIndex ABMultiValueGetFirstIndexOfValue ( ABMultiValueRef multiValue, CFTypeRef value );
The multivalue property in which to search for value.
The value to search for in multiValue.
Location of value within multiValue, -1 if value is not present in multiValue.
ABMultiValue.hReturns the identifier of a value in a multivalue property.
ABMultiValueIdentifier ABMultiValueGetIdentifierAtIndex ( ABMultiValueRef multiValue, CFIndex index );
The multivalue property with the identifier to return.
Location of the value within multiValue whose identifier is being returned.
Identifier of the value at index within multiValue.
ABMultiValue.hReturns the location (within a multivalue property) of a value with a given identifier.
CFIndex ABMultiValueGetIndexForIdentifier ( ABMultiValueRef multiValue, ABMultiValueIdentifier identifier );
The multivalue property in which to look for the identifier value identifier.
The identifier of the value whose location within multiValue is being returned.
Location within multiValue that contains the value with identifier as its identifier.
ABMultiValue.hReturns the type of the values contained in a multivalue property.
ABPropertyType ABMultiValueGetPropertyType ( ABMultiValueRef multiValue );
The multivalue property whose type is being returned.
The type of the values contained in multiValue or kABInvalidPropertyType when multiValue is empty or contains values of different types.
ABMultiValue.hReference to a multivalue property.
typedef CFTypeRef ABMultiValueRef;
ABMultiValue.hIdentifies multivalue properties.
typedef int32_t ABMultiValueIdentifier;
ABMultiValue.hThis preprocessor definition identifies an multivalue property with values whose type does not match its declared type.
#define kABMultiValueInvalidIdentifier -1
kABMultiValueInvalidIdentifierInvalid multivalue property.
Available in iOS 2.0 and later.
Declared in ABMultiValue.h.
Last updated: 2010-03-23