IOHIDDeviceTransactionInterface

Объект Вы используете для доступа к транзакции HID от пространства пользователя, возвращенного версией 1.5 IOHIDFamily.

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

Наследование

Не применимый

Соответствует

Не применимый

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

Не применимый не применимый

Прочие условия


    
    addElement
    - addElement

Добавляет элемент к этому экземпляру IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *addElement)( void *self, IOHIDElementRef element, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, который будет добавлен к транзакции.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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


    
    ясный
    - ясный

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

Объявление

C++

IOReturn ( *clear)( void *self, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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

Обсуждение

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


    
    фиксация
    - фиксация

Передает транзакцию элемента IOHIDDevice в этом экземпляре IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *commit)( void *self, uint32_t timeout, IOHIDCallback callback, void *context, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`timeout`	Тайм-аут в миллисекундах для выпуска транзакции.
`callback`	Обратный вызов типа IOHIDCallback, который будет использоваться, когда была завершена транзакция. Если ноль, этот метод будет вести себя синхронно.
`context`	Указатель на данные, которые будут переданы обратному вызову.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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

Обсуждение

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

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


    
    containsElement
    - containsElement

Проверки, был ли элемент добавлен к этому экземпляру IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *containsElement)( void *self, IOHIDElementRef element, Boolean *pValue, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, чтобы быть быть найденным в транзакции.
`pValue`	Указатель на булевскую переменную, чтобы возвратиться, был ли элемент найден в транзакции.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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


    
    getAsyncEventSource
    - getAsyncEventSource

Получает источник события для этого экземпляра IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *getAsyncEventSource)( void *self, CFTypeRef *pSource);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`pSource`	Указатель на CFType для возврата источника события цикла выполнения.

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

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

Обсуждение

Возвращенный источник события может иметь тип CFRunLoopSourceRef или CFRunLoopTimerRef.


    
    getDirection
    - getDirection

Получает направление для этого экземпляра IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *getDirection)( void *self, IOHIDTransactionDirectionType *pDirection);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`pDirection`	Указатель на IOHIDTransactionDirectionType для получения направления транзакции.

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

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

Обсуждение

Константы направления объявляются в IOHIDTransactionDirectionType.


    
    getValue
    - getValue

Получает рыночную стоимость для элемента в этом экземпляре IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *getValue)( void *self, IOHIDElementRef element, IOHIDValueRef *pValue, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`element`	IOHIDElementRef, ссылающийся на элемент интереса.
`pValue`	Указатель на IOHIDValueRef для возврата значения элемента транзакции.
`options`	Посмотрите IOHIDTransactionOption.

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

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

Обсуждение

Используйте kIOHIDTransactionOptionDefaultOutputValue опцию получить значение элемента по умолчанию.


    
    removeElement
    - removeElement

Удаляет элемент из этого экземпляра IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *removeElement)( void *self, IOHIDElementRef element, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, который будет удален из транзакции.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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


    
    setDirection
    - setDirection

Устанавливает направление для этого экземпляра IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *setDirection)( void *self, IOHIDTransactionDirectionType direction, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`direction`	Направление транзакции типа IOHIDTransactionDirectionType.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

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

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

Обсуждение

Константы направления объявляются в IOHIDTransactionDirectionType. Изменение направлений полезно при контакте с элементами типа kIOHIDElementTypeFeature, поскольку Вы используете транзакцию для и установки и получаете значения элемента.


    
    setValue
    - setValue

Устанавливает рыночную стоимость для элемента в этом экземпляре IOHIDDeviceTransactionInterface.

Объявление

C++

IOReturn ( *setValue)( void *self, IOHIDElementRef element, IOHIDValueRef value, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`element`	IOHIDElementRef, ссылающийся на элемент интереса.
`value`	IOHIDValueRef, ссылающийся на значение элемента, которое будет использоваться в транзакции.
`options`	Посмотрите IOHIDTransactionOption.

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

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

Обсуждение

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