HidD_SetOutputReport 函数 (hidsdi.h)
HidD_SetOutputReport例程将输出报表发送到顶级集合。
仅使用此例程来设置集合的当前状态。 某些设备可能不支持此例程,如果使用此例程,将变得无响应。 有关详细信息,请参阅 通过 User-Mode 应用程序发送 HID 报表。
语法
BOOLEAN HidD_SetOutputReport(
[in] HANDLE HidDeviceObject,
[in] PVOID ReportBuffer,
[in] ULONG ReportBufferLength
);
参数
[in] HidDeviceObject
顶级集合的打开句柄。
[in] ReportBuffer
指向调用方分配的输出报表缓冲区的指针,调用方使用该缓冲区指定报表 ID。
有关此参数的详细信息,请参阅 备注 部分。
[in] ReportBufferLength
报表缓冲区的大小(以字节为单位)。 报表缓冲区必须足够大,才能保存输出报表以及一个指定非零报表 ID 的附加字节。 如果未使用报表 ID,则 ID 值为零。
返回值
如果 HidD_SetOutputReport 成功,则返回 TRUE;否则,它将返回 FALSE。 使用 GetLastError 获取扩展错误信息。
注解
正确的 ReportBufferLength 是由从 HidP_GetCaps 调用返回的顶级集合HIDP_CAPS结构的 OutputReportByteLength 成员指定的。
在调用 HidD_SetOutputReport 例程之前,调用方必须执行以下操作:
- 如果 顶级集合 包含报表 ID,则调用方必须将 ReportBuffer 参数的第一个字节设置为非零报表 ID。
- 如果 顶级集合 不包含报表 ID,则调用方必须将 ReportBuffer 参数的第一个字节设置为零。
- 输出报表由 ReportBuffer 参数引用。 根据报表 ID,调用方通过调用以下函数之一来准备报表:
有关如何准备和 HID 报表并将其发送到 顶级集合的示例,请参阅 HClient 示例应用程序。
只有用户模式应用程序才能调用 HidD_SetOutputReport。 内核模式驱动程序可以使用 IOCTL_HID_SET_OUTPUT_REPORT 请求。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 在 Windows XP 和更高版本的 Windows 中可用。 |
目标平台 | 通用 |
标头 | hidsdi.h (包括 Hidsdi.h) |
Library | Hid.lib |
DLL | Hid.dll |