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 是由從 HidP_GetCaps 呼叫傳回之最上層集合之HIDP_CAPS結構的 FeatureReportByteLength 成員所指定。
呼叫 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 要求。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 可在 Windows 2000 和更新版本的 Windows 中使用。 |
目標平台 | Universal |
標頭 | hidsdi.h (包含 Hidsdi.h) |
程式庫 | Hid.lib |
Dll | Hid.dll |