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

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

Синтаксис

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

Параметры

[in] HidDeviceObject

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

[in] ReportBuffer

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

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

[in] ReportBufferLength

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

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

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

Замечания

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

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

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

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

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

Требования

См. также

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