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 集合。