HidD_GetManufacturerString関数 (hidsdi.h)

[アーティクル]
03/05/2024

HidD_GetManufacturerString ルーチンは、製造元を識別する最上位のコレクションの埋め込み文字列を返します。

構文

BOOLEAN HidD_GetManufacturerString(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  Buffer,
  [in]  ULONG  BufferLength
);

パラメーター

[in] HidDeviceObject

最上位のコレクションに対する開いているハンドルを指定します。

[out] Buffer

ルーチンがコレクションの製造元文字列を返すために使用する呼び出し元によって割り当てられたバッファーへのポインター。ルーチンは、人間が判読できる形式で NULL で終わるワイド文字列を返します。

[in] BufferLength

Buffer で提供される呼び出し元によって割り当てられたバッファーの長さをバイト単位で指定 します。バッファーが NULL で終わる埋め込み文字列全体を返すのに十分な大きさでない場合、ルーチンはバッファー内で何も返しません。指定するバッファーは <、 = 4093 バイト (2^12 – 3) である必要があります。

戻り値

HidD_HidD_GetManufacturerStringは、NULL で終わる埋め込み文字列全体を返す場合に TRUE を 返します。それ以外の場合、ルーチンは FALSE を返します。 GetLastError を使用して、拡張エラー情報を取得します。

注釈

HidD_GetManufacturerStringを呼び出すことができるのは、ユーザーモードアプリケーションだけです。カーネルモードドライバーは、 IOCTL_HID_GET_MANUFACTURER_STRING 要求を使用できます。

埋め込み文字列内で使用できる最大文字数は、デバイス固有です。 USB デバイスの場合、文字列の最大長は 126 文字です (終端の NULL 文字は含まれません)。

指定されたバッファーが = 4093 バイト (2^12 – 3) でない <場合、呼び出しは失敗する可能性があります (基になるプロトコル、HID/Bluetooth/SPI によっては)、エラーコードがERROR_GEN_FAILURE (0x0000001f)。

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

要件

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