Ссылка IOHIDDescriptorParser.h
Включенные заголовки
<TargetConditionals.h>
<IOKit/IOTypes.h>
<IOKit/hidsystem/IOHIDUsageTables.h>
-
Избавляется от памяти синтаксический анализатор, выделенный для функции HIDOpenReportDescriptor.
Объявление
Objective C
OSStatus HIDCloseReportDescriptor ( HIDPreparsedDataRef preparsedDataRef );
Параметры
hidReportDescriptor
Содержит указатель на фактический дескриптор отчета HID от встроенного микропрограммного обеспечения USB-устройства
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, возвращающегося функцией HIDOpenReportDescriptor. После звонка к функции HIDCloseReportDescriptor preparsedDataRef недопустим и не должен использоваться.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Возвращает структуры возможностей кнопки для устройства HID на основе данных предварительно проанализированных данных.
Объявление
Objective C
OSStatus HIDGetButtonCapabilities ( HIDReportType reportType, HIDButtonCapabilitiesPtr buttonCaps, UInt32 *buttonCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, для которого можно получить масштабированное значение. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport
buttonCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDButtonCapabilities. Структуры содержат информацию для всех кнопок, удовлетворяющих критерии поиска
buttonCapsSize
Содержит размер массива buttonCaps, передал в функции и установлен в число элементов, фактически помещенное в массив после того, как завершается вызов.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Возвращает структуры возможностей кнопки для устройства HID на основе данных предварительно проанализированных данных.
Объявление
Objective C
OSStatus HIDGetButtonCaps ( HIDReportType reportType, HIDButtonCapsPtr buttonCaps, UInt32 *buttonCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, для которого можно получить масштабированное значение. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport
buttonCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDButtonCaps. Структуры содержат информацию для всех кнопок, удовлетворяющих критерии поиска
buttonCapsSize
Содержит размер массива buttonCaps, передал в функции и установлен в число элементов, фактически помещенное в массив после того, как завершается вызов.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetButtons берет отчет от устройства HID и получает текущее состояние кнопок в том отчете.
Объявление
Objective C
OSStatus HIDGetButtons ( HIDReportType reportType, UInt32 collection, HIDUsageAndPagePtr usageList, UInt32 *usageListSize, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета, предоставленного в параметре отчета, от которого можно получить кнопки. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport или kHIDFeatureReport
collection
Дополнительно указывает, что идентификатор набора ссылки раньше получал только определенные состояния кнопки. Если это значение является ненулевым, только кнопки, которые являются частью данного набора, возвращаются.
usageList
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему использования всех нажимающихся кнопок.
usageListSize
Размер, в элементах матрицы, буфера, предоставленного в usageList параметре. По возврату этот параметр содержит число состояний кнопки, установленных этой подпрограммой. Если ошибка kHIDBufferToSmallErr была возвращена, этот параметр содержит число элементов матрицы, требуемых содержать все запрошенные данные кнопки. Максимальное количество кнопок, которые могут когда-либо возвращаться для данного типа отчета, может быть получено путем вызывания функции HIDMaxUsageListLength.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает длину, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Получает информацию о статистике кнопки для кнопок на указанной странице использования.
Объявление
Objective C
OSStatus HIDGetButtonsOnPage ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage *usageList, UInt32 *usageListSize, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета, предоставленного в параметре отчета, от которого можно получить кнопки. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport или kHIDFeatureReport.
usagePage
Указывает страницу использования кнопок, для которых можно получить текущее состояние.
collection
Дополнительно указывает, что идентификатор набора ссылки раньше получал только определенные состояния кнопки. Если это значение является ненулевым, только кнопки, которые являются частью данного набора, возвращаются.
usageList
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему использования всех кнопок, которые являются perssed и принадлежат странице использования, указанной в usagePage параметре.
usageListSize
Размер, в элементах матрицы, буфера, предоставленного в usageList параметре. По возврату этот параметр содержит число состояний кнопки, установленных этой подпрограммой. Если ошибка kHIDBufferTooSmallErr была возвращена, этот параметр содержит число элементов матрицы, требуемых содержать все запрошенные данные кнопки. Максимальное количество кнопок, которые могут когда-либо возвращаться для данного типа отчета, может быть получено путем вызывания функции HIDMaxUsageListLength.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Возвращает возможности устройства HID на основе данных предварительно проанализированных данных.
Объявление
Objective C
OSStatus HIDGetCapabilities ( HIDPreparsedDataRef preparsedDataRef, HIDCapabilitiesPtr capabilities );
Параметры
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
capabilities
Точки к вызывающей стороне выделили буфер, по возврату содержащий проанализированную информацию о возможности для этого устройства HID.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Возвращает возможности устройства HID на основе данных предварительно проанализированных данных.
Объявление
Objective C
OSStatus HIDGetCaps ( HIDPreparsedDataRef preparsedDataRef, HIDCapsPtr capabilities );
Параметры
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
capabilities
Точки к вызывающей стороне выделили буфер, по возврату содержащий проанализированную информацию о возможности для этого устройства HID.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Возвращает массив структур HIDCollectionNode, описывающих отношения и расположение наборов ссылки в этом высокоуровневом наборе.
Объявление
Objective C
OSStatus HIDGetCollectionNodes ( HIDCollectionNodePtr collectionNodes, UInt32 *collectionNodesSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
collectionNodes
Точки к выделенному вызывающей стороне массиву структур HIDCollectionNode, в которых эта подпрограмма возвращает запись для каждого набора в высокоуровневом наборе. Набор является группой соответствующих дескрипторов HID, содержащих ввод, вывод и элементы функции, имеющие некоторое общее отношение друг другу. Например, набор указателя содержит элементы для данных позиции x и y и данных кнопки.
collectionNodesSize
На вводе, указывает длину в элементах матрицы буфера, предоставленного в collectionNodes. На выводе этот параметр устанавливается на число инициализированных записей в массиве collectionNodes.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Длина требуемого буфера, в элементах матрицы, для всего массива узла набора найдена в элементе структуры HIDCaps numberCollectionNodes. Вы получаете информацию HIDCaps путем вызывания функции HIDGetCaps. Для получения информации об отношениях наборов ссылки, описанных по условию, возвратился из этой подпрограммы, см. описание структуры HIDCollectionNode.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetScaledUsageValue возвращает возможности всех кнопок для данного высокоуровневого набора.
Объявление
Objective C
OSStatus HIDGetScaledUsageValue ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, SInt32 *usageValue, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета, для которого можно получить масштабированное значение. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает страницу использования значения, которое будет получено.
collection
Дополнительно указывает идентификатор набора ссылки значения, которое будет получено.
usage
Указывает использование масштабированного значения, которое будет получено.
usageValue
Точки к переменной, по возврату из этой подпрограммы содержащей масштабированное значение, полученное из отчета устройства.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства
reportLength
Указывает длину, в байтах, отчетных данных, предоставленных в отчете
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Клиенты, кто, чтобы получить все возможности использования, содержащего многократные элементы данных для единственного использования, соответствующего массиву байтов HID, должны вызвать функцию HIDGetUsageValueArray.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Получает возможности всех кнопок в определенном типе отчета, удовлетворяющих критерии поиска.
Объявление
Objective C
OSStatus HIDGetSpecificButtonCapabilities ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, HIDButtonCapabilitiesPtr buttonCaps, UInt32 *buttonCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности кнопки. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования для использования в качестве критерии поиска. Если этот параметр будет ненулевым, то только кнопки, указывающие эту страницу использования, будут получены.
collection
Указывает идентификатор набора ссылки для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только кнопки, которые являются частью указанного набора ссылки, получены.
usage
Указывает идентификатор использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только кнопки, соответствующие указанное значение, получены.
buttonCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDButtonCapabilities. Структуры содержат информацию для всех кнопок, удовлетворяющих критерии поиска.
buttonCapsLength
На вводе, указывает длину, в элементах матрицы, буфера, предоставленного в buttonCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены вызовом функции в буфере, предоставленном в buttonCaps параметре, если подпрограмма завершилась без ошибки. Корректная длина, необходимая для получения возможностей кнопки, может быть найдена в данных возможности, возвращенных для устройства функцией HIDGetCaps.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetSpecificButtonCapabilities получает данные возможности для кнопок, встречающих данный критерии поиска, в противоположность функции HIDGetButtonCapabilities, возвращающей данные возможности для всех кнопок на устройстве. Вызывание этого нуля указания подпрограммы для usagePage, использования и набора эквивалентно вызыванию функции HIDGetButtonCapabilities.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Получает возможности всех кнопок в определенном типе отчета, удовлетворяющих критерии поиска.
Объявление
Objective C
OSStatus HIDGetSpecificButtonCaps ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, HIDButtonCapsPtr buttonCaps, UInt32 *buttonCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности кнопки. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования для использования в качестве критерии поиска. Если этот параметр будет ненулевым, то только кнопки, указывающие эту страницу использования, будут получены.
collection
Указывает идентификатор набора ссылки для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только кнопки, которые являются частью указанного набора ссылки, получены.
usage
Указывает идентификатор использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только кнопки, соответствующие указанное значение, получены.
buttonCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDButtonCaps. Структуры содержат информацию для всех кнопок, удовлетворяющих критерии поиска.
buttonCapsLength
На вводе, указывает длину, в элементах матрицы, буфера, предоставленного в buttonCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены вызовом функции в буфере, предоставленном в buttonCaps параметре, если подпрограмма завершилась без ошибки. Корректная длина, необходимая для получения возможностей кнопки, может быть найдена в данных возможности, возвращенных для устройства функцией HIDGetCaps.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetSpecificButtonCaps получает данные возможности для кнопок, встречающих данный критерии поиска, в противоположность функции HIDGetButtonCaps, возвращающей данные возможности для всех кнопок на устройстве. Вызывание этого нуля указания подпрограммы для usagePage, использования и набора эквивалентно вызыванию функции HIDGetButtonCaps.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Получает возможности всех значений в определенном типе отчета, удовлетворяющих критерии поиска.
Объявление
Objective C
OSStatus HIDGetSpecificValueCapabilities ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, HIDValueCapabilitiesPtr valueCaps, UInt32 *valueCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности значения. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые указывают, что будет получена эта страница использования.
collection
Указывает идентификатор набора ссылки для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые являются частью этого набора ссылки, будет получен.
usage
Указывает идентификатор использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые указывают, что будет получено это использование.
valueCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDValueCapabilities, содержащих информацию для всех значений, удовлетворяющих критерии поиска.
valueCapsSize
Указывает длину на вводе, в элементах матрицы, буфера, предоставленного в valueCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены этим вызовом функции в буфере, предоставленном в valueCaps параметре, если подпрограмма завершилась без ошибки. Корректная длина, необходимая для получения возможностей значения, может быть найдена в данных возможности, возвращенных для устройства из функции HIDGetCaps.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetSpecificValueCapabilities получает данные возможности для значений, удовлетворяющих данные критерии поиска, в противоположность функции HIDGetValueCapabilities, возвращающей данные возможности для всех значений на устройстве. Вызывая эту подпрограмму со значением нуля для usagePage, параметры использования и набора эквивалентны вызыванию функции HIDGetValueCapabilities.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Получает возможности всех значений в определенном типе отчета, удовлетворяющих критерии поиска.
Объявление
Objective C
OSStatus HIDGetSpecificValueCaps ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, HIDValueCapsPtr valueCaps, UInt32 *valueCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности значения. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые указывают, что будет получена эта страница использования.
collection
Указывает идентификатор набора ссылки для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые являются частью этого набора ссылки, будет получен.
usage
Указывает идентификатор использования для использования в качестве критерии поиска. Если этот параметр является ненулевым, то только оценивает, которые указывают, что будет получено это использование.
valueCaps
Точки к выделенному вызывающей стороне буферу, который будет содержать, по возврату, массиву структур HIDValueCaps, содержащих информацию для всех значений, удовлетворяющих критерии поиска.
valueCapsSize
Указывает длину на вводе, в элементах матрицы, буфера, предоставленного в valueCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены этим вызовом функции в буфере, предоставленном в valueCaps параметре, если подпрограмма завершилась без ошибки. Корректная длина, необходимая для получения возможностей значения, может быть найдена в данных возможности, возвращенных для устройства из функции HIDGetCaps.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetSpecificValueCaps получает данные возможности для значений, удовлетворяющих данные критерии поиска, в противоположность функции HIDGetValueCaps, возвращающей данные возможности для всех значений на устройстве. Вызывая эту подпрограмму со значением нуля для usagePage, параметры использования и набора эквивалентны вызыванию функции HIDGetValueCaps.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetUsageValue возвращается, значение от данных устройства сообщают данный выбранные критерии поиска.
Объявление
Objective C
OSStatus HIDGetUsageValue ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, SInt32 *usageValue, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета, предоставленного в отчете, из которого можно получить значение. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает страницу использования значения для получения.
collection
Дополнительно указывает идентификатор набора ссылки значения, которое будет получено.
usage
Указывает использование значения, которое будет получено.
usageValue
Точки к переменной, по возврату из этой подпрограммы содержащей значение, полученное из отчета устройства.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetUsageValue не подписывает значение. Для применения знакового бита автоматически используйте функцию HIDGetScaledUsageValue вместо этого. Для того, чтобы вручную присвоить знаковый бит, позиция знакового бита может быть найдена в структуре HIDValueCaps для этого значения. Клиенты, хотящие получить все данные для использования, содержащего многократные элементы данных для единственного использования, соответствуя массиву байтов HID, должны вызвать функцию HIDGetUsageValueArray вместо этого.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetUsageValueArray возвращается, значение от данных устройства сообщают данный выбранные критерии поиска.
Объявление
Objective C
OSStatus HIDGetUsageValueArray ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, UInt8 *usageValueBuffer, IOByteCount usageValueBufferSize, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета, предоставленного в отчете, из которого можно получить значение. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает страницу использования данных, которые будут получены.
collection
Дополнительно указывает идентификатор набора ссылки данных, которые будут получены.
usage
Указывает идентификатор использования значения, которое будет получено.
usageValueBuffer
Точки к выделенному вызывающей стороне буферу, содержащему, на выводе, данных от устройства. Корректная длина для этого буфера может быть найдена путем умножения reportCount и bitSize полей структуры HIDValueCaps для значения и округления получающегося значения до самого близкого байта.
usageValueBufferSize
Указывает размер, в байтах, буфера в usageValueBuffer параметре.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в отчете.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Когда функция HIDGetUsageValueArray получает данные, она заполняет буфер в порядке с прямым порядком байтов, начинающемся с младшего значащего бита данных для этого использования. Данные заполнены во вне зависимости от выравнивания байта и смещаются таким образом, что младший значащий бит помещается как 1-й бит данного буфера.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetValueCapabilities получает возможности всех значений для указанного высокоуровневого набора.
Объявление
Objective C
OSStatus HIDGetValueCapabilities ( HIDReportType reportType, HIDValueCapabilitiesPtr valueCaps, UInt32 *valueCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности значения. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
valueCaps
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему массив структур HIDValueCapabilities, содержащих информацию для всех значений в высокоуровневом наборе.
valueCapsSize
На вводе, указывает размер в элементах матрицы буфера, предоставленного в valueCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены в буфере, предоставленном в valueCaps параметре, если функция завершилась без ошибки. Корректная длина, необходимая для получения возможностей значения, может быть найдена в данных возможности, возвращенных для устройства функцией HIDGetCapabilities.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetValueCapabilities получает данные возможности для всех значений в высокоуровневом наборе не принимая во внимание использование, страницу использования или набор значения. Для получения возможностей значения определенного использования, страницы использования или набора, используют функцию HIDGetSpecificValueCapabilities.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDGetValueCaps получает возможности всех значений для указанного высокоуровневого набора.
Объявление
Objective C
OSStatus HIDGetValueCaps ( HIDReportType reportType, HIDValueCapsPtr valueCaps, UInt32 *valueCapsSize, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, которого можно получить возможности значения. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
valueCaps
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему массив структур HIDValueCaps, содержащих информацию для всех значений в высокоуровневом наборе.
valueCapsSize
На вводе, указывает размер в элементах матрицы буфера, предоставленного в valueCaps параметре. На выводе этот параметр устанавливается на фактическое число элементов, которые были возвращены в буфере, предоставленном в valueCaps параметре, если функция завершилась без ошибки. Корректная длина, необходимая для получения возможностей значения, может быть найдена в данных возможности, возвращенных для устройства функцией HIDGetCaps.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDGetValueCaps получает данные возможности для всех значений в высокоуровневом наборе не принимая во внимание использование, страницу использования или набор значения. Для получения возможностей значения определенного использования, страницы использования или набора, используют функцию HIDGetSpecificValueCaps.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDMaxUsageListLength возвращает максимальное количество кнопок, которые могут быть возвращены из данного типа отчета для высокоуровневого набора.
Объявление
Objective C
UInt32 HIDMaxUsageListLength ( HIDReportType reportType, HIDUsage usagePage, HIDPreparsedDataRef preparsedDataRef );
Параметры
reportType
Указывает тип отчета, для которого можно получить максимальное количество использования. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Дополнительно указывает идентификатор страницы использования для использования в качестве критерии поиска. Если этот параметр является нулем, функция возвращает число кнопок для всего набора верхнего уровня независимо от фактического значения страницы использования.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDOpenReportDescriptor выделяет память, синтаксический анализатор должен обработать данный дескриптор отчета, и затем анализирует дескриптор отчета.
Объявление
Objective C
OSStatus HIDOpenReportDescriptor ( void *hidReportDescriptor, IOByteCount descriptorLength, HIDPreparsedDataRef *preparsedDataRef, UInt32 flags );
Параметры
hidReportDescriptor
Содержит указатель на фактический дескриптор отчета HID от встроенного микропрограммного обеспечения USB-устройства
descriptorLength
Длина HID сообщает о дескрипторе
preparsedDataRef
Предварительно проанализированная ссылка на данные, которая будет использоваться для последующих вызовов функции
flags
Флаги для этого runction являются kHIDFlag_StrictErrorChecking = 0x00000001
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Когда проанализированная информация больше не необходима, клиенты должны вызвать функцию HIDCloseReportDescriptor.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDSetButton берет отчет от устройства HID и устанавливает текущее состояние указанной кнопки в том отчете.
Объявление
Objective C
OSStatus HIDSetButton ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования значения, которое будет установлено в отчете.
collection
Дополнительно указывает идентификатор набора ссылки для различения кнопки. Если этот параметр является нулем, он проигнорирован.
usage
Точки к выделенному вызывающей стороне буферу, содержащему данные кнопки, которые будут установлены в отчете в параметре отчета.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDSetButtons берет отчет от устройства HID и возвращает текущее состояние кнопок в том отчете.
Объявление
Objective C
OSStatus HIDSetButtons ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage *usageList, UInt32 *usageListSize, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип repor. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования значения, которое будет установлено в отчете.
collection
Дополнительно указывает идентификатор набора ссылки для различения кнопки. Если этот параметр является нулем, он проигнорирован.
usageList
Точки к выделенному вызывающей стороне буферу, содержащему массив данных кнопки, которые будут установлены в отчете в параметре отчета.
usageListSize
Указывает размер, в элементах матрицы, буфера, предоставленного в usageList параметре. Если ошибка возвращается вызовом к этой функции, usageListLength параметр содержит расположение в массиве, предоставленном в usageList параметре, где встретились с ошибкой. Все записи массива, с которыми встречаются до ошибочного расположения, были успешно установлены в отчете, предоставленном в параметре отчета.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDSetScaledUsageValue берет физическое (масштабированное) число со знаком и преобразовывает его в логическое, или представление устройства и вставляет его в данный отчет.
Объявление
Objective C
OSStatus HIDSetScaledUsageValue ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, SInt32 usageValue, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования значения, которое будет установлено в отчете.
collection
Дополнительно указывает идентификатор набора ссылки для различения значения, имеющие ту же страницу использования и идентификаторы использования. Если этот параметр будет нулем, то он будет проигнорирован.
usage
Указывает идентификатор использования значения, которое будет установлено в отчете.
usageValue
Указывает медосмотр, или масштабируемый, значение, которое будет установлено в значении для данного отчета.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
Specifies
длина, в байтах отчетных данных указана в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDSetScaledUsageValue автоматически обрабатывает установку бита со знаком в данных, которые будут отправлены в устройство.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDSetUsageValue устанавливает значение в дать отчете.
Объявление
Objective C
OSStatus HIDSetUsageValue ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, SInt32 usageValue, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования значения, которое будет установлено в отчете.
collection
Дополнительно указывает идентификатор набора ссылки для различения значения, имеющие ту же страницу использования и идентификаторы использования. Если этот параметр является нулем, он проигнорирован.
usage
Указывает идентификатор использования значения, которое будет установлено в отчете.
usageValue
Указывает данные, которые должны быть установлены в значении для данного отчета.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDSetUsageVlaue автоматически не обрабатывает знаковый бит. Клиенты должны или вручную установить знаковый бит, в позиции, предоставленной в структуре HIDValueCaps для этого значения, или вызвать функцию HIDSetScaledUsageValue.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDSetUsageValueArray устанавливает массив значений в данном отчете.
Объявление
Objective C
OSStatus HIDSetUsageValueArray ( HIDReportType reportType, HIDUsage usagePage, UInt32 collection, HIDUsage usage, UInt8 *usageValueBuffer, IOByteCount usageValueBufferLength, HIDPreparsedDataRef preparsedDataRef, void *report, IOByteCount reportLength );
Параметры
reportType
Указывает тип отчета. Этот параметр должен быть одним из следующего: kHIDInputReport, kHIDOutputReport, или kHIDFeatureReport.
usagePage
Указывает идентификатор страницы использования значения, которое будет установлено в отчете.
collection
Дополнительно указывает идентификатор набора ссылки для различения значения, имеющие ту же страницу использования и идентификаторы использования. Если этот параметр является нулем, он проигнорирован.
usage
Указывает идентификатор использования значения, которое будет установлено в отчете.
usageValueBuffer
Точки к выделенному вызывающей стороне буферу, содержащему, на выводе, данных от устройства. Корректная длина для этого буфера может быть найдена путем умножения reportCount и bitSize полей структуры HIDValueCaps для этого значения и округления получающегося значения до самого близкого байта.
usageValueBufferLength
Указывает размер, в байтах, буфера в usageValueBuffer параметре.
preparsedDataRef
Предварительно проанализированная ссылка на данные для отчета, повторно настраивающегося функцией HIDOpenReportDescriptor
report
Точки к выделенному вызывающей стороне буферу, содержащему отчетные данные устройства.
reportLength
Указывает размер, в байтах, отчетных данных, предоставленных в параметре отчета.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Обсуждение
Функция HIDSetUsageValue автоматически не обрабатывает знаковый бит. Клиенты должны или вручную установить знаковый бит, в позиции, предоставленной в структуре HIDValueCaps для этого значения, или вызвать функцию HIDSetScaledUsageValue.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Функция HIDUsageListDifference сравнивает и обеспечивает различия между двумя списками кнопок.
Объявление
Objective C
OSStatus HIDUsageListDifference ( HIDUsage *previousUsageList, HIDUsage *currentUsageList, HIDUsage *breakUsageList, HIDUsage *makeUsageList, UInt32 usageListsSize );
Параметры
previousUsageList
Точки к более старой кнопке перечисляют, чтобы использоваться для сравнения.
currentUsageList
Точки к более новой кнопке перечисляют, чтобы использоваться для сравнения.
breakUsageList
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему набор кнопок в более старом списке, указанном в previousUsageList параметре, но не наборе в новом списке, указанном в currentUsageList параметре.
makeUsageList
По возврату, точкам к выделенному вызывающей стороне буферу, содержащему набор кнопок в новом списке, указанном в currentUsageList параметре, но не наборе в старом списке, указанном в previousUsageList параметре.
usageListsLength
Указывает длину, в элементах матрицы, буферов, предоставленных в currentUsageList и previousUssageList параметрах.
Возвращаемое значение
Если с ошибкой встретились или noErr на успехе, OSStatus Возвращают код ошибки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
Посмотрите раздел Overview выше для документации уровня заголовка.
-
Структура данных HIDCaps используется клиентами HID для содержания возможностей устройства HID.
Объявление
Objective C
typedef struct HIDCaps HIDCaps, * HIDCapsPtr;
Обсуждение
Эта структура содержит проанализированные возможности, и максимумы данных возвратились для устройства функцией HIDGetCaps.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Структура данных HIDCaps используется клиентами HID для содержания возможностей устройства HID.
Объявление
Objective C
typedef struct HIDCaps HIDCaps, * HIDCapsPtr;
Обсуждение
Эта структура содержит проанализированные возможности, и максимумы данных возвратились для устройства функцией HIDGetCaps.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Структура данных HIDUsageAndPage используется клиентами HID при получении состояния кнопок для содержания страницы использования и использования снижающейся кнопки.
Объявление
Objective C
typedef struct HIDUsageAndPage HIDUsageAndPage, *HIDUsageAndPagePtr;
Обсуждение
Клиенты используют структуру HIDUSageAndPage с функцией HIDGetButtonsEx для получения и страницы использования и идентификаторов использования каждой снижающейся кнопки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Структура данных HIDUsageAndPage используется клиентами HID при получении состояния кнопок для содержания страницы использования и использования снижающейся кнопки.
Объявление
Objective C
typedef struct HIDUsageAndPage HIDUsageAndPage, *HIDUsageAndPagePtr;
Обсуждение
Клиенты используют структуру HIDUSageAndPage с функцией HIDGetButtonsEx для получения и страницы использования и идентификаторов использования каждой снижающейся кнопки.
Оператор импорта
Objective C
#include <IOHIDDescriptorParser.h>;
Доступность
Доступный в OS X v10.0 и позже.
-
Структура данных HIDCaps используется клиентами HID для содержания возможностей устройства HID.
Объявление
Objective C
struct HIDCaps { HIDUsage usage; HIDUsage usagePage; IOByteCount inputReportByteLength; IOByteCount outputReportByteLength; IOByteCount featureReportByteLength; UInt32 numberCollectionNodes; UInt32 numberInputButtonCaps; UInt32 numberInputValueCaps; UInt32 numberOutputButtonCaps; UInt32 numberOutputValueCaps; UInt32 numberFeatureButtonCaps; UInt32 numberFeatureValueCaps; };
Поля
usage
Указывает определенный класс функциональности, которую обеспечивает это устройство. Это значение зависит и является определенным для значения, предоставленного в usagePage поле. Например, клавиатура могла иметь usagePage kHIDUsagePage_Generic и использование kHIDUsage_Generic_Keyboard.
usagePage
Указывает идентификатор страницы использования для этого высокоуровневого набора.
inputReportByteLength
Указывает максимальную длину, в байтах, входного отчета для этого устройства, включая идентификатор отчета, в одностороннем порядке предварительно ожидающийся к данным устройства.
outputReportByteLength
Указывает максимальную длину, в байтах, выходного отчета для этого устройства, включая идентификатор отчета, в одностороннем порядке предварительно ожидающийся к данным устройства.
featureReportByteLength
Указывает максимальную длину, в байтах, отчета функции для этого устройства, включая идентификатор отчета, в одностороннем порядке предварительно ожидающийся к данным устройства.
numberCollectionNodes
Указывает число структур HIDCollectionNode, возвращающихся для этого высокоуровневого набора функцией HIDGetConnectionNodes.
numberInputButtonCaps
Указывает число входных кнопок.
numberInputValueCaps
Указывает число входных значений.
numberOutputButtonCaps
Указывает число выходных кнопок.
numberOutputValueCaps
Указывает число выходных значений
numberFeatureButtonCaps
Указывает число функциональных кнопок.
numberFeatureValueCaps
Указывает число значений функции.
Обсуждение
Эта структура содержит проанализированные возможности, и максимумы данных возвратились для устройства функцией HIDGetCaps.
-
Структура данных HIDUsageAndPage используется клиентами HID при получении состояния кнопок для содержания страницы использования и использования снижающейся кнопки.
Объявление
Objective C
struct HIDUsageAndPage { HIDUsage usage; HIDUsage usagePage; };
Поля
usage
Указывает идентификатор использования в странице использования, указанной usagePage снижающейся кнопки.
usagePage
Указывает идентификатор страницы использования снижающейся кнопки.
Обсуждение
Клиенты используют структуру HIDUSageAndPage с функцией HIDGetButtonsEx для получения и страницы использования и идентификаторов использования каждой снижающейся кнопки.