функция HidD_GetFeature (hidsdi.h)

Подпрограмма HidD_GetFeature возвращает отчет о функциях из указанной коллекции верхнего уровня.

Синтаксис

BOOLEAN HidD_GetFeature(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  ReportBuffer,
  [in]  ULONG  ReportBufferLength
);

Параметры

[in] HidDeviceObject

Открытый дескриптор коллекции верхнего уровня.

[out] ReportBuffer

Указатель на выделенный вызывающим буфером отчета HID, который вызывающий объект использует для указания идентификатора отчета. HidD_GetFeature использует ReportBuffer для возврата указанного отчета о функциях.

Дополнительные сведения об этом параметре см. в разделе Примечания .

[in] ReportBufferLength

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

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

Если HidD_GetFeature выполнено успешно, возвращается значение TRUE; В противном случае возвращается значение FALSE. Используйте GetLastError для получения расширенных сведений об ошибке.

Комментарии

Правильный объект ReportBufferLength определяется элементом FeatureReportByteLengthструктуры HIDP_CAPS коллекции верхнего уровня, возвращаемой из HidP_GetCaps вызова.

Прежде чем вызывать подпрограмму HidD_GetFeature , вызывающий объект должен выполнить следующие действия:

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

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

Пример анализа отчета HID см. в примере приложения HClient . Этот пример находится в коллекции кода MSDN.

Только приложения в пользовательском режиме могут вызывать HidD_GetFeature. Драйверы режима ядра могут использовать запрос IOCTL_HID_GET_FEATURE .

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows 2000 и более поздних версиях Windows.
Целевая платформа Универсальное
Верхняя часть hidsdi.h (включая Hidsdi.h)
Библиотека Hid.lib
DLL Hid.dll

См. также раздел