функция 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. В зависимости от идентификатора отчета вызывающий объект анализирует отчет, вызывая одну из следующих функций:

• HidP_GetButtonCaps
• HidP_GetData
• HidP_GetExtendedAttributes
• HidP_GetScaledUsageValue
• HidP_GetSpecificButtonCaps
• HidP_GetSpecificValueCaps
• HidP_GetUsages
• HidP_GetUsagesEx
• HidP_GetUsageValue
• HidP_GetUsageValueArray
• HidP_GetValueCaps

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

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

Требования

См. также

• получение отчетов HID
• интерпретация отчетов HID
• HidD_GetInputReport
• HidD_SetFeature
• HidD_SetOutputReport
• HIDP_CAPS
• HidP_GetCaps
• IOCTL_HID_GET_FEATURE
• IOCTL_HID_GET_INPUT_REPORT
• IOCTL_HID_SET_FEATURE
• IOCTL_HID_SET_OUTPUT_REPORT