HidD_GetSerialNumberString関数 (hidsdi.h)

[アーティクル]
02/29/2024

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) でない <場合は、エラーコード ERROR_GEN_FAILURE (0x0000001f) で呼び出しが失敗する可能性があります (基になるプロトコル、HID/Bluetooth/SPI によっては)

詳細については、「 HID コレクション」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム	ユニバーサル
Header	hidsdi.h (Hidsdi.h を含む)
Library	Hid.lib
[DLL]	Hid.dll