GetRawInputDeviceInfoA 関数 (winuser.h)

  • [アーティクル]

生入力デバイスに関する情報を取得します。

構文

UINT GetRawInputDeviceInfoA(
  [in, optional]      HANDLE hDevice,
  [in]                UINT   uiCommand,
  [in, out, optional] LPVOID pData,
  [in, out]           PUINT  pcbSize
);

パラメーター

[in, optional] hDevice

型: HANDLE

生入力デバイスへのハンドル。 これは、RAWINPUTHEADER の hDevice メンバーまたは GetRawInputDeviceList から取得されます。

[in] uiCommand

型: UINT

pData で返されるデータを指定します。 このパラメーターには、次の値のいずれかを指定できます。

値 意味
RIDI_PREPARSEDDATA
0x20000005
 pData は、最上位のコレクションの準備されたデータのバッファーへのPHIDP_PREPARSED_DATA ポインターです。
RIDI_DEVICENAME
0x20000007
 pData は、 デバイス インターフェイス名を含む文字列を指します。

このデバイスが 共有アクセス モードで開かれている 場合は、この名前で CreateFile を 呼び出して HID コレクションを開き、返されたハンドルを使用して ReadFile を呼び出して入力レポートを読み取り、 WriteFile を使用して出力レポートを送信できます。

詳細については、「 HID コレクションを開く」 と「 HID レポートの処理」を参照してください。

この uiCommand の場合のみ、 pcbSize の値は文字数です (バイト数ではありません)。
RIDI_DEVICEINFO
0x2000000b
 pData は 、RID_DEVICE_INFO 構造体を指します。

[in, out, optional] pData

種類: LPVOID

uiCommand で指定された情報を含むバッファーへのポインター。

uiCommand がRIDI_DEVICEINFO場合は、GetRawInputDeviceInfo を呼び出す前に、RID_DEVICE_INFOの cbSize メンバーを にsizeof(RID_DEVICE_INFO)設定します。

[in, out] pcbSize

型: PUINT

pData 内のデータのサイズ (バイト単位)。

戻り値

型: UINT

成功した場合、この関数は pData にコピーされたバイト数を示す負以外の数値を返します。

pData がデータに対して十分な大きさでない場合、関数は -1 を返します。 pData が NULL の場合、関数は 0 の値を返します。 どちらの場合も、 pcbSize は pData バッファーに必要な最小サイズに設定されます。

GetLastError を呼び出して、他のエラーを特定します。

注釈

注意

winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetRawInputDeviceInfo を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-rawinput-l1-1-0 (Windows 10 バージョン 10.0.14393 で導入)

関連項目

概念

RAWINPUTHEADER

RID_DEVICE_INFO

未加工の入力

参照

WM_INPUT

最上位のコレクション

事前解析データ

PHIDP_PREPARSED_DATA

HID コレクションを開く

HID レポートを処理する