Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылочная ссылка ABMutableMultiValue C платформы AddressBook

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка ABMutableMultiValue C

ABMultiValue и ABMutableMultiValue, непрозрачные типы используются для представления свойств, которые могли бы иметь многократные значения. Каждое значение в списке мультизначения должно быть тем же типом и предопределило связанное или определяемую пользователем метку и уникальный идентификатор. Метки, однако, не должны быть уникальными. Например, у Вас могут быть многократные «Домашние» телефонные номера. Когда метка не предоставлена, каждый объект мультизначения может иметь основной идентификатор — используемый в качестве значения по умолчанию. Например, запись лица может иметь многократные адреса с метками «Домой» и «Работой», где «Работа» определяется как основное значение. Экземпляры ABMutableMultiValue являются непостоянными, видят ABMultiValue для дополнительных функций, получающих доступ к содержанию списка мультизначения.

Можно использовать любого ABMultiValueAdd или ABMultiValueInsert функции к добавленной стоимости / маркируют пар к списку мультизначения. Можно удалить запись в списке мультизначения с помощью ABMultiValueRemove функция. Можно также заменить значения и метки с помощью ABMultiValueReplaceLabelи ABMultiValueReplaceValue функции.

Используйте ABMultiValueSetPrimaryIdentifier функционируйте, чтобы установить основной идентификатор — т.е. определять соответствующее значение как значение по умолчанию для списка мультизначения. Используйте ABMultiValueCopyIdentifierAtIndex функция для получения уникального идентификатора для пары значения/метки.

ABMutableMultiValue непрозрачный тип “бесплатный соединенный мостом” с его дубликатом Objective C. Это означает что ABMutableMultiValueRef тип является взаимозаменяемым в вызовах функции или вызовах метода с экземплярами класса ABMutableMultiValue.

Функции

  • Добавляют значение и его метка к списку мультизначения.

    Объявление

    Swift

    func ABMultiValueAdd(_ multiValue: ABMutableMultiValue!, _ value: AnyObject!, _ label: CFString!, _ outIdentifier: UnsafeMutablePointer<Unmanaged<CFString>?>) -> Bool

    Objective C

    bool ABMultiValueAdd ( ABMutableMultiValueRef multiValue, CFTypeRef value, CFStringRef label, CFStringRef *outIdentifier );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    value

    Объект, представляющий значение в списке мультизначения - это должно иметь корректный тип. Например, если multiValue значение для свойства типа kABMultiStringProperty, тогда value потребности быть объектом CFString. Посмотрите Property Types для списка поддерживаемых типов в списке мультизначения (см. описания kABMulti... константы). Если value NULL, эта функция повышает исключение.

    label

    Метка для value— это не должно быть уникально. Если label NULL, эта функция повышает исключение.

    outIdentifier

    Если value добавляется успешно, этот параметр возвращает новый идентификатор.

    Возвращаемое значение

    true если успешно, false иначе.

    Обсуждение

    Эта функция не выполняет проверки типа и позволит Вам добавить значение, тип которого не соответствует типы других значений в списке. Однако, при попытке использовать список мультизначения, значения которого не являются всем тем же типом, функциями, такими как ABRecord ABRecordSetValue функционируйте, будут возвраты NULL или kABErrorInProperty.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Возвращает недавно создаваемый непостоянный объект списка мультизначения.

    Объявление

    Swift

    func ABMultiValueCreateMutable() -> Unmanaged<ABMutableMultiValue>!

    Objective C

    ABMutableMultiValueRef ABMultiValueCreateMutable ( void );

    Возвращаемое значение

    Недавно создаваемый объект ABMutableMultiValue. Вы ответственны за выпуск этого объекта.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Вставляет значение и его метку в данном индексе в списке мультизначения.

    Объявление

    Swift

    func ABMultiValueInsert(_ multiValue: ABMutableMultiValue!, _ value: AnyObject!, _ label: CFString!, _ index: CFIndex, _ outIdentifier: UnsafeMutablePointer<Unmanaged<CFString>?>) -> Bool

    Objective C

    bool ABMultiValueInsert ( ABMutableMultiValueRef multiValue, CFTypeRef value, CFStringRef label, CFIndex index, CFStringRef *outIdentifier );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    value

    Объект, представляющий значение в списке мультизначения - это должно иметь корректный тип. Например, если multiValue значение для свойства типа kABMultiStringProperty, тогда value потребности быть объектом CFString. Посмотрите Property Types для списка поддерживаемых типов в списке мультизначения (см. описания kABMulti... константы). Если value NULL, эта функция повышает исключение.

    label

    Метка для value— это не должно быть уникально. Если label NULL, эта функция повышает исключение.

    index

    Индекс для вставки value в. Если index выходит за пределы, эта функция повышает исключение.

    outIdentifier

    Если value добавляется успешно, этот параметр возвращает новый идентификатор.

    Возвращаемое значение

    true если успешно, false иначе.

    Обсуждение

    Эта функция не выполняет проверки типа и позволит Вам добавить значение, тип которого не соответствует типы других значений в списке. Однако, при попытке использовать список мультизначения, значения которого не являются всем тем же типом, функциями, такими как ABRecord ABRecordSetValue функционируйте, будут возвраты NULL или kABErrorProperty.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Удаляет значение и метку в данном индексе.

    Объявление

    Swift

    func ABMultiValueRemove(_ multiValue: ABMutableMultiValue!, _ index: CFIndex) -> Bool

    Objective C

    bool ABMultiValueRemove ( ABMutableMultiValueRef multiValue, CFIndex index );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    index

    Индекс записи, которая будет удалена. Если index выходит за пределы, эта функция повышает исключение.

    Возвращаемое значение

    true если успешно, false иначе.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Заменяет метку в данном индексе.

    Объявление

    Swift

    func ABMultiValueReplaceLabel(_ multiValue: ABMutableMultiValue!, _ label: CFString!, _ index: CFIndex) -> Bool

    Objective C

    bool ABMultiValueReplaceLabel ( ABMutableMultiValueRef multiValue, CFStringRef label, CFIndex index );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    label

    Новая метка в index— это не должно быть уникально. Если label NULL, эта функция повышает исключение.

    index

    Индекс записи, которая будет изменена. Если index выходит за пределы, эта функция повышает исключение.

    Возвращаемое значение

    true если успешно, false иначе.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Заменяет значение в данном индексе.

    Объявление

    Swift

    func ABMultiValueReplaceValue(_ multiValue: ABMutableMultiValue!, _ value: AnyObject!, _ index: CFIndex) -> Bool

    Objective C

    bool ABMultiValueReplaceValue ( ABMutableMultiValueRef multiValue, CFTypeRef value, CFIndex index );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    value

    Объект, представляющий новое значение в списке мультизначения - это должно иметь корректный тип. Например, если multiValue значение для свойства типа kABMultiStringProperty, тогда value потребности быть объектом CFString. Посмотрите Property Types для списка поддерживаемых типов в списке мультизначения (см. описания kABMulti... константы). Если value NULL, эта функция повышает исключение.

    index

    Индекс записи, которая будет изменена. Если index выходит за пределы, эта функция повышает исключение.

    Возвращаемое значение

    true если успешно, false иначе.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • Устанавливает основное значение, чтобы быть значением для данного идентификатора.

    Объявление

    Swift

    func ABMultiValueSetPrimaryIdentifier(_ multiValue: ABMutableMultiValue!, _ identifier: CFString!) -> Bool

    Objective C

    bool ABMultiValueSetPrimaryIdentifier ( ABMutableMultiValueRef multiValue, CFStringRef identifier );

    Параметры

    multiValue

    Список мультизначения Вы хотите изменить.

    identifier

    Идентификатор, соответствующий значению, Вы хотите определять как основное значение для этого списка мультизначения. Используйте ABMultiValueCopyIdentifierAtIndex функция для получения идентификатора, данного индекс. Если identifier NULL, эта функция повышает исключение.

    Возвращаемое значение

    true если успешно, false иначе.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

Типы данных

  • Ссылка на объект ABMutableMultiValue.

    Объявление

    Swift

    typealias ABMutableMultiValueRef = ABMutableMultiValue

    Objective C

    typedef struct __ABMultiValue *ABMutableMultiValueRef;

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.