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

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

Разработчик

Ссылка платформы SystemConfiguration ссылка SCDynamicStore

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

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

Ссылка SCDynamicStore

SCDynamicStore интерфейс программирования обеспечивает доступ к парам ключ/значение в динамической памяти рабочей системы. Динамическая память содержит, среди других элементов, копии параметров конфигурации для в настоящее время активного набора (который иногда называется как расположение), и информация о текущем состоянии сети.

Функции в SCDynamicStore интерфейс программирования позволяет Вам находить пары ключ/значение, добавлять или удалять пары ключ/значение, добавлять или изменять значения и запрашивать уведомления. Обратите внимание на то, что эти функции следуют Базовым соглашениям имени функции Основы. Имеющая функция «Создает», или «Копия» на ее имя возвращает ссылку, которую необходимо выпустить с CFRelease функция.

Для использования этих функций необходимо сначала установить сеанс динамической памяти с помощью SCDynamicStoreCreate функция. Когда Вы закончите с сеансом, использовать CFRelease закрыть его.

Функции

  • Создает новый сеанс, используемый для взаимодействия с динамической памятью, сохраняемой сервером Конфигурации системы.

    Объявление

    Swift

    func SCDynamicStoreCreateWithOptions(_ allocator: CFAllocator!, _ name: CFString!, _ storeOptions: CFDictionary!, _ callout: SCDynamicStoreCallBack, _ context: UnsafeMutablePointer<SCDynamicStoreContext>) -> Unmanaged<SCDynamicStore>!

    Objective C

    SCDynamicStoreRef SCDynamicStoreCreateWithOptions ( CFAllocatorRef allocator, CFStringRef name, CFDictionaryRef storeOptions, SCDynamicStoreCallBack callout, SCDynamicStoreContext *context );

    Параметры

    allocator

    Средство выделения, которое должно использоваться для выделения памяти для локального объекта динамической памяти. Этот параметр может быть NULL когда используется текущее средство выделения по умолчанию. Если это значение не является допустимым CFAllocatorRef, поведение не определено.

    name

    Имя обработки вызовов или плагин вызывающей стороны.

    storeOptions

    Словарь опций для сеанса динамической памяти (такой как, добавили ли все ключи или установили в динамическую память, должно быть на сеансовые ключи). Передача NULL если не желаемы никакие опции.

    В настоящее время доступные параметры:

    Ключ

    Значение

    kSCDynamicStoreUseSessionKeys

    CFBooleanRef

    callout

    Функция, которую вызовут, когда изменяется наблюдаемое значение в динамической памяти. Передача NULL если не желаемы никакие выноски.

    context

    Контекст связался с выноской. Посмотрите SCDynamicStoreContext для получения дополнительной информации об этом значении.

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

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

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Создает новый сеанс, используемый для взаимодействия с динамической памятью, сохраняемой сервером Конфигурации системы.

    Объявление

    Swift

    func SCDynamicStoreCreate(_ allocator: CFAllocator!, _ name: CFString!, _ callout: SCDynamicStoreCallBack, _ context: UnsafeMutablePointer<SCDynamicStoreContext>) -> Unmanaged<SCDynamicStore>!

    Objective C

    SCDynamicStoreRef SCDynamicStoreCreate ( CFAllocatorRef allocator, CFStringRef name, SCDynamicStoreCallBack callout, SCDynamicStoreContext *context );

    Параметры

    allocator

    Средство выделения, которое должно использоваться для выделения памяти для локального объекта динамической памяти. Этот параметр может быть NULL когда используется текущее средство выделения по умолчанию. Если это значение не является допустимым CFAllocatorRef, поведение не определено.

    name

    Имя обработки вызовов или плагин вызывающей стороны.

    callout

    Функция, которую вызовут, когда изменяется наблюдаемое значение в динамической памяти. Передача NULL если не желаемы никакие выноски.

    context

    Контекст связался с выноской. Посмотрите SCDynamicStoreContext для получения дополнительной информации об этом значении.

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

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

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Если никакой такой ключ уже не существует, временно добавляет указанную пару ключ/значение к динамической памяти.

    Объявление

    Swift

    func SCDynamicStoreAddTemporaryValue(_ store: SCDynamicStore!, _ key: CFString!, _ value: CFPropertyList!) -> Boolean

    Objective C

    Boolean SCDynamicStoreAddTemporaryValue ( SCDynamicStoreRef store, CFStringRef key, CFPropertyListRef value );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ значения, чтобы добавить к динамической памяти.

    value

    Значение, чтобы добавить к динамической памяти.

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

    TRUE если был добавлен ключ; FALSE если ошибка произошла, если ключ уже присутствовал в динамической памяти или.

    Обсуждение

    Если ключ не обновляется другим сеансом, пара ключ/значение, добавленная этой функцией, удалена автоматически, когда закрывается сеанс.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Если никакой такой ключ уже не существует, добавляет указанная пара ключ/значение к динамической памяти.

    Объявление

    Swift

    func SCDynamicStoreAddValue(_ store: SCDynamicStore!, _ key: CFString!, _ value: CFPropertyList!) -> Boolean

    Objective C

    Boolean SCDynamicStoreAddValue ( SCDynamicStoreRef store, CFStringRef key, CFPropertyListRef value );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ значения, чтобы добавить к динамической памяти.

    value

    Значение, чтобы добавить к динамической памяти.

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

    TRUE если был добавлен ключ; FALSE если ошибка произошла, если ключ уже присутствовал в динамической памяти или.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Обновления многократные значения в динамической памяти.

    Объявление

    Swift

    func SCDynamicStoreSetMultiple(_ store: SCDynamicStore!, _ keysToSet: CFDictionary!, _ keysToRemove: CFArray!, _ keysToNotify: CFArray!) -> Boolean

    Objective C

    Boolean SCDynamicStoreSetMultiple ( SCDynamicStoreRef store, CFDictionaryRef keysToSet, CFArrayRef keysToRemove, CFArrayRef keysToNotify );

    Параметры

    store

    Сеанс динамической памяти.

    keysToSet

    Словарь пар ключ/значение, чтобы добавить к динамической памяти.

    keysToRemove

    Массив ключей для удаления из динамической памяти.

    keysToNotify

    Массив ключей для установки флага, как изменено (не изменяя их значения).

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

    TRUE если обновления динамической памяти были успешны; иначе, FALSE.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

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

    Объявление

    Swift

    func SCDynamicStoreSetValue(_ store: SCDynamicStore!, _ key: CFString!, _ value: CFPropertyList!) -> Boolean

    Objective C

    Boolean SCDynamicStoreSetValue ( SCDynamicStoreRef store, CFStringRef key, CFPropertyListRef value );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ связался со значением.

    value

    Значение для добавления к или замена в динамической памяти.

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

    TRUE если был обновлен ключ; иначе, FALSE.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

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

    Объявление

    Swift

    func SCDynamicStoreCopyKeyList(_ store: SCDynamicStore!, _ pattern: CFString!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef SCDynamicStoreCopyKeyList ( SCDynamicStoreRef store, CFStringRef pattern );

    Параметры

    store

    Сеанс динамической памяти.

    pattern

    A regex(3) образец регулярного выражения раньше соответствовал ключи динамической памяти.

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

    Массив соответствия ключей, или NULL если произошла ошибка. Необходимо выпустить возвращенное значение.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Возвращает пары ключ/значение, соответствующие указанные ключи и комбинации клавиш.

    Объявление

    Swift

    func SCDynamicStoreCopyMultiple(_ store: SCDynamicStore!, _ keys: CFArray!, _ patterns: CFArray!) -> Unmanaged<CFDictionary>!

    Objective C

    CFDictionaryRef SCDynamicStoreCopyMultiple ( SCDynamicStoreRef store, CFArrayRef keys, CFArrayRef patterns );

    Параметры

    store

    Сеанс динамической памяти.

    keys

    Ключи связались с требуемыми значениями или NULL если не требуют никакие определенные ключи.

    patterns

    Массив regex(3) строки образца раньше соответствовали ключи, или NULL если не требуют никакие комбинации клавиш.

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

    Словарь пар ключ/значение, соответствующих указанные ключи и комбинации клавиш, или NULL если произошла ошибка. Необходимо выпустить возвращенное значение.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Возвращает ключи, изменившиеся начиная с последней возможности на эту функцию.

    Объявление

    Swift

    func SCDynamicStoreCopyNotifiedKeys(_ store: SCDynamicStore!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef SCDynamicStoreCopyNotifiedKeys ( SCDynamicStoreRef store );

    Параметры

    store

    Сеанс динамической памяти.

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

    Ключи, изменившиеся, или NULL если произошла ошибка. Необходимо выпустить возвращенное значение.

    Обсуждение

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

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Возвращает значение, связанное с указанным ключом.

    Объявление

    Swift

    func SCDynamicStoreCopyValue(_ store: SCDynamicStore!, _ key: CFString!) -> Unmanaged<CFPropertyList>!

    Objective C

    CFPropertyListRef SCDynamicStoreCopyValue ( SCDynamicStoreRef store, CFStringRef key );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ связался с требуемым значением.

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

    Значение связалось с указанным ключом, или NULL если ошибка произошла, если никакое значение не было расположено или. Необходимо выпустить возвращенное значение.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

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

    Объявление

    Swift

    func SCDynamicStoreNotifyValue(_ store: SCDynamicStore!, _ key: CFString!) -> Boolean

    Objective C

    Boolean SCDynamicStoreNotifyValue ( SCDynamicStoreRef store, CFStringRef key );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ, который должен быть отмечен, как изменено. Все сеансы динамической памяти, контролирующие этот ключ, получат уведомление. Обратите внимание на то, что значение ключа не обновляется.

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

    TRUE если было обработано уведомление; FALSE если произошла ошибка.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Указывает ряд ключей и комбинаций клавиш, которые должны контролироваться для изменений.

    Объявление

    Swift

    func SCDynamicStoreSetNotificationKeys(_ store: SCDynamicStore!, _ keys: CFArray!, _ patterns: CFArray!) -> Boolean

    Objective C

    Boolean SCDynamicStoreSetNotificationKeys ( SCDynamicStoreRef store, CFArrayRef keys, CFArrayRef patterns );

    Параметры

    store

    Наблюдаемый сеанс динамической памяти.

    keys

    Массив ключей, которые будут контролироваться или NULL если не должны контролироваться никакие определенные ключи.

    patterns

    Массив regex(3) строки образца раньше соответствовали ключи, которые будут контролироваться или NULL если не должны контролироваться никакие комбинации клавиш.

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

    TRUE если был успешно обновлен набор ключей уведомления и образцов; иначе, FALSE.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

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

    Объявление

    Swift

    func SCDynamicStoreSetDispatchQueue(_ store: SCDynamicStore!, _ queue: dispatch_queue_t!) -> Boolean

    Objective C

    Boolean SCDynamicStoreSetDispatchQueue ( SCDynamicStoreRef store, dispatch_queue_t queue );

    Параметры

    store

    Сеанс динамической памяти.

    queue

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

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

    TRUE если успешно инициировались уведомления; иначе, FALSE.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Удаляет значение указанного ключа из динамической памяти.

    Объявление

    Swift

    func SCDynamicStoreRemoveValue(_ store: SCDynamicStore!, _ key: CFString!) -> Boolean

    Objective C

    Boolean SCDynamicStoreRemoveValue ( SCDynamicStoreRef store, CFStringRef key );

    Параметры

    store

    Сеанс динамической памяти.

    key

    Ключ значения для удаления.

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

    TRUE если был удален ключ; FALSE если никакое значение не было расположено, или ошибка произошла.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Создает исходный объект цикла выполнения, который может быть добавлен к циклу выполнения приложения.

    Объявление

    Swift

    func SCDynamicStoreCreateRunLoopSource(_ allocator: CFAllocator!, _ store: SCDynamicStore!, _ order: CFIndex) -> Unmanaged<CFRunLoopSource>!

    Objective C

    CFRunLoopSourceRef SCDynamicStoreCreateRunLoopSource ( CFAllocatorRef allocator, SCDynamicStoreRef store, CFIndex order );

    Параметры

    allocator

    Средство выделения, которое должно использоваться для выделения памяти для источника цикла выполнения. Этот параметр может быть NULL когда используется текущее средство выделения по умолчанию. Если это значение не является допустимым CFAllocatorRef, поведение не определено.

    store

    Сеанс динамической памяти.

    order

    Порядок, в котором источники, которые готовы быть обработанными, обрабатываются на платформах, поддерживающих его и для исходных версий, поддерживающих его. Источник с числом более низкоуровневым обрабатывается перед источником с числом высшего порядка. Это нецелесообразно для зависимости от номера заказа для любого архитектурного аспекта или аспекта проекта кода. В отсутствие любой причины сделать иначе, передать 0 для этого параметра.

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

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

    Обсуждение

    Обратите внимание на то, что все уведомления динамической памяти поставлены с помощью источника цикла выполнения эта функция возвраты.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Возвращает идентификатор типа всех SCDynamicStore экземпляры.

    Объявление

    Swift

    func SCDynamicStoreGetTypeID() -> CFTypeID

    Objective C

    CFTypeID SCDynamicStoreGetTypeID ( void );

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

    Идентификатор типа всех SCDynamicStore экземпляры.

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

Типы данных

  • Когда уведомление об изменениях, внесенных в динамическую память, поставлено, обратный вызов использовал.

    Объявление

    Swift

    typealias SCDynamicStoreCallBack = CFunctionPointer<((SCDynamicStore!, CFArray!, UnsafeMutablePointer<Void>) -> Void)>

    Objective C

    typedef void (*SCDynamicStoreCallBack) ( SCDynamicStoreRef store, CFArrayRef changedKeys, void *info );

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

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

    Объявление

    Swift

    struct SCDynamicStoreContext { var version: CFIndex var info: UnsafeMutablePointer<Void> var retain: CFunctionPointer<((UnsafePointer<Void>) -> UnsafePointer<Void>)> var release: CFunctionPointer<((UnsafePointer<Void>) -> Void)> var copyDescription: CFunctionPointer<((UnsafePointer<Void>) -> Unmanaged<CFString>!)> }

    Objective C

    typedef struct { CFIndex version; void * info; const void *(*retain)(const void *info); void (*release)(const void *info); CFStringRef (*copyDescription)(const void *info); } SCDynamicStoreContext;

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

  • Дескриптор к открытому сеансу динамической памяти с демоном конфигурации системы.

    Объявление

    Swift

    typealias SCDynamicStoreRef = SCDynamicStore

    Objective C

    typedef const struct __SCDynamicStore * SCDynamicStoreRef;

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

    Objective C

    @import SystemConfiguration;

    Swift

    import SystemConfiguration

    Доступность

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

Константы

  • Ключи, указывающие опции для сеанса динамической памяти.

    Объявление

    Swift

    let kSCDynamicStoreUseSessionKeys: CFString!

    Objective C

    const CFStringRef kSCDynamicStoreUseSessionKeys;

    Константы

    • kSCDynamicStoreUseSessionKeys

      kSCDynamicStoreUseSessionKeys

      Все ключи добавили или установили в динамическую память, должно быть на сеансовые ключи.

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