HidD_GetSerialNumberString函式 (hidsdi.h)
HidD_GetSerialNumberString例程會傳回最上層集合的內嵌字串,識別集合實體裝置的序號。
語法
BOOLEAN HidD_GetSerialNumberString(
[in] HANDLE HidDeviceObject,
[out] PVOID Buffer,
[in] ULONG BufferLength
);
參數
[in] HidDeviceObject
指定最上層集合的開啟句柄。
[out] Buffer
呼叫端配置的緩衝區指標,例程用來傳回要求的序號字串。 例程會傳回NULL終止的寬字元字串。
[in] BufferLength
指定在 Buffer 上提供之呼叫端配置緩衝區的長度,以位元組為單位。 如果緩衝區不夠大,無法傳回整個NULL終止的內嵌字串,則例程不會在緩衝區中傳回任何內容。 提供的緩衝區必須是 <= 4093 個字節, (2^12 – 3 個) 。
傳回值
如果成功 傳回整個NULL終止的內嵌字串,HidD_GetSerialNumberString會傳回 TRUE 。 否則,例程會傳回 FALSE。 使用 GetLastError 取得擴充的錯誤資訊。
備註
只有使用者模式應用程式可以呼叫 HidD_GetSerialNumberString。 核心模式驅動程式可以使用 IOCTL_HID_GET_SERIALNUMBER_STRING。
內嵌字串中可能的最大字元數是裝置特定的。 對於USB裝置,字串長度上限為126個字元, (不包含終止的NULL字元) 。
如果提供的緩衝區不是 <= 4093 個字節, (2^12 – 3) ,則呼叫可能會因為基礎通訊協定 HID/Bluetooth/SPI) (而失敗ERROR_GEN_FAILURE (0x0000001f)
如需詳細資訊,請參閱 HID 集合。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 可在 Windows 2000 和更新版本的 Windows 中使用。 |
目標平台 | Universal |
標頭 | hidsdi.h (包含 Hidsdi.h) |
程式庫 | Hid.lib |
Dll | Hid.dll |