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

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

Разработчик

Ссылка IOHIDTransaction.h

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

На этой странице

Ссылка IOHIDTransaction.h

IOHIDTransaction определяет объект, используемый для управления многократными проанализированными элементами (IOHIDElement), содержавший в объекте Human Interface Device (HID). Это используется, чтобы минимизировать коммуникацию устройства при взаимодействии с функцией и вывести элементы типа, сгруппированные их идентификаторами отчетов. IOHIDTransaction является объектом CFType, и как таковой соответствует всем соглашениям, ожидал такой объект.

Эта документация предполагает, что у Вас есть основное понимание материала, содержавшегося в Для определений терминов Набора I/O, использованных в этой документации, таких как соответствие словаря, семьи и драйвера, см. обзор условий Набора I/O и понятий в «Доступе к устройствам и главе» Набора I/O Доступа к Аппаратным средствам Из Приложений.

Эта документация также предполагает, что Вы читали. Рассмотрите документацию перед использованием этой ссылки.

Вся информация, описанная в этом документе, содержится в заголовочном файле IOHIDTransaction.h найденный в /System/Library/Frameworks/IOKit.framework/Headers/hid/IOHIDTransaction.h.

Включенные заголовки

  • <CoreFoundation/CoreFoundation.h>

  • <IOKit/hid/IOHIDBase.h>

Функции

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

    Объявление

    Objective C

    void IOHIDTransactionAddElement ( IOHIDTransactionRef transaction, IOHIDElementRef element );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    element

    Элемент, который будет добавлен к транзакции.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Очищает рыночную стоимость элемента.

    Объявление

    Objective C

    void IOHIDTransactionClear ( IOHIDTransactionRef transaction );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    Обсуждение

    В отношении kIOHIDTransactionDirectionTypeOutput направления будут сохранены значения элемента по умолчанию.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Синхронно передает транзакцию элемента устройству.

    Объявление

    Objective C

    IOReturn IOHIDTransactionCommit ( IOHIDTransactionRef transaction );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

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

    Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.

    Обсуждение

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

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

    Objective C

    @import IOKit;

    Доступность

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

  • Передает транзакцию элемента устройству.

    Объявление

    Objective C

    IOReturn IOHIDTransactionCommitWithCallback ( IOHIDTransactionRef transaction, CFTimeInterval timeout, IOHIDCallback callback, void *context );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    timeout

    Тайм-аут для выпуска транзакции.

    callback

    Обратный вызов типа IOHIDCallback, который будет использоваться, когда была завершена транзакция. Если ноль, этот метод будет вести себя синхронно.

    context

    Указатель на данные, которые будут переданы обратному вызову.

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

    Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.

    Обсуждение

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

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

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

    Objective C

    @import IOKit;

    Доступность

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

  • Запрашивает транзакцию, чтобы определить, был ли добавлен elemement.

    Объявление

    Objective C

    Boolean IOHIDTransactionContainsElement ( IOHIDTransactionRef transaction, IOHIDElementRef element );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть запрошенными.

    element

    Элемент, который будет запрошен.

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

    Истина или ложь возвратов, зависящая, если присутствует элемент.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Создает объект IOHIDTransaction для указанного устройства.

    Объявление

    Objective C

    IOHIDTransactionRef IOHIDTransactionCreate ( CFAllocatorRef allocator, IOHIDDeviceRef device, IOHIDTransactionDirectionType direction, IOOptionBits options );

    Параметры

    allocator

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

    device

    Объект IOHIDDevice

    direction

    Направление, или в или, для транзакции.

    options

    Зарезервированный для будущего использования.

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

    Возвращает новый IOHIDTransactionRef.

    Обсуждение

    Объекты IOHIDTransaction могут использоваться, чтобы или отправить или получить многократные значения элемента. Как таковой используемое направление должно представлять, они вводят объектов, добавленных к транзакции.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Получите устройство, связанное с транзакцией.

    Объявление

    Objective C

    IOHIDDeviceRef IOHIDTransactionGetDevice ( IOHIDTransactionRef transaction );

    Параметры

    transaction

    IOHIDTransaction, который будет запрошен.

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

    Возвращает ссылку на устройство.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Получите направление транзакции.

    Объявление

    Objective C

    IOHIDTransactionDirectionType IOHIDTransactionGetDirection ( IOHIDTransactionRef transaction );

    Параметры

    transaction

    IOHIDTransaction, который будет запрошен.

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

    Возвращает направление транзакции.

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

    Objective C

    @import IOKit;

    Доступность

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

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

    Объявление

    Objective C

    CFTypeID IOHIDTransactionGetTypeID ( void );

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

    Objective C

    @import IOKit;

    Доступность

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

  • Получает значение для элемента транзакции.

    Объявление

    Objective C

    IOHIDValueRef IOHIDTransactionGetValue ( IOHIDTransactionRef transaction, IOHIDElementRef element, IOOptionBits options );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть запрошенными.

    element

    Элемент, который будет запрошен.

    options

    Посмотрите IOHIDTransactionOption.

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

    Возвраты IOHIDValueRef для данного элемента.

    Обсуждение

    Если направление транзакции является kIOHIDTransactionDirectionTypeInput, значение представляет то, что было получено из устройства от транзакции. Иначе, если направление транзакции является kIOHIDTransactionDirectionTypeOutput, значение представляет незаконченное значение, которое будет отправлено в устройство. Используйте kIOHIDTransactionOptionDefaultOutputValue опцию получить значение элемента по умолчанию.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Удаляет элемент к транзакции

    Объявление

    Objective C

    void IOHIDTransactionRemoveElement ( IOHIDTransactionRef transaction, IOHIDElementRef element );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    element

    Элемент, который будет удален к транзакции.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Транзакция расписаний с выполненным циклом.

    Объявление

    Objective C

    void IOHIDTransactionScheduleWithRunLoop ( IOHIDTransactionRef transaction, CFRunLoopRef runLoop, CFStringRef runLoopMode );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    runLoop

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

    runLoopMode

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

    Обсуждение

    Формально транзакция партнеров с циклом выполнения клиента. Планирование этой транзакции с циклом выполнения необходимо перед использованием любого асинхронного APIs.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Устанавливает направление транзакции @disussion, Этот метод полезен для управления bi-направлением (функция) элементы, таким образом, что можно установить или получить значения элемента, не создавая дополнительный объект транзакции.

    Объявление

    Objective C

    void IOHIDTransactionSetDirection ( IOHIDTransactionRef transaction, IOHIDTransactionDirectionType direction );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    direction

    Новое направление транзакции.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Устанавливает значение для элемента транзакции.

    Объявление

    Objective C

    void IOHIDTransactionSetValue ( IOHIDTransactionRef transaction, IOHIDElementRef element, IOHIDValueRef value, IOOptionBits options );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    element

    Элемент, который будет изменен после фиксации.

    value

    Значение, которое будет установлено для данного элемента.

    options

    Посмотрите IOHIDTransactionOption.

    Обсуждение

    Набор значений ожидается, пока транзакция не фиксируется и только используется, если направление транзакции является kIOHIDTransactionDirectionTypeOutput. Используйте kIOHIDTransactionOptionDefaultOutputValue опцию установить значение элемента по умолчанию.

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

    Objective C

    @import IOKit;

    Доступность

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

  • Транзакция нерасписаний с выполненным циклом.

    Объявление

    Objective C

    void IOHIDTransactionUnscheduleFromRunLoop ( IOHIDTransactionRef transaction, CFRunLoopRef runLoop, CFStringRef runLoopMode );

    Параметры

    transaction

    IOHIDTransaction возражают, чтобы быть измененными.

    runLoop

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

    runLoopMode

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

    Обсуждение

    Формально разъединяет транзакцию с циклом выполнения клиента.

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

    Objective C

    @import IOKit;

    Доступность

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

Типы данных

См. Обзор для документации уровня заголовка.

  • Объявление

    Objective C

    typedef struct __IOHIDTransaction * IOHIDTransactionRef;

    Обсуждение

    Это - тип ссылки на IOHIDTransaction.

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

    Objective C

    @import IOKit;

    Доступность

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