IDirectInputDevice8::GetObjectInfo メソッド

IDirectInputDevice8::GetObjectInfo メソッド

ボタンや軸などのデバイス オブジェクトの情報を取得する。

構文

HRESULT GetObjectInfo(      
    LPDIDEVICEOBJECTINSTANCE pdidoi,
    DWORD dwObj,
    DWORD dwHow
);

パラメータ

• pdidoi
  オブジェクトの情報を格納する DIDEVICEOBJECTINSTANCE 構造体のアドレス。この構造体の dwSize メンバは、このメソッドを呼び出す前に初期化しておかなければならない。
• dwObj
  取得する情報が所属するオブジェクトを識別する値。このパラメータに設定する値は、dwHow パラメータで指定されている値に依存する。
• dwHow
  dwObj パラメータの解釈方法を指定する値。dwHow には、次のいずれかの値を指定できる。
  • DIPH_BYOFFSET
    dwObj パラメータは、アクセスする情報が所属するオブジェクトの現在のデータ形式に対するオフセットである。
  • DIPH_BYID
    dwObj パラメータは、オブジェクトの型またはインスタンス識別子である。この識別子は、IDirectInputDevice8::EnumObjects メソッドを前回呼び出した際の戻り値である DIDEVICEOBJECTINSTANCE 構造体の dwType メンバに返される。
  • DIPH_BYUSAGE
    dwObj パラメータは、オブジェクトの "HID 使用ページ" と "使用状況" の値である。これらの値は DIMAKEUSAGEDWORD マクロにより組み合わせられる。

戻り値

成功した場合は、DI_OK を返す。

失敗した場合は、次のいずれかのエラー値を返す。

DIERR_INVALIDPARAM	無効なパラメータが、戻ってくる関数に渡されたか、オブジェクトがその関数を呼び出せる状態になかった。この値は、標準のコンポーネント オブジェクト モデル (COM) 戻り値である E_INVALIDARG に等しい。
DIERR_NOTINITIALIZED	このオブジェクトは初期化されていない。
DIERR_OBJECTNOTFOUND	要求されたオブジェクトは存在しない。
E_POINTER	無効なポインタ (通常は NULL) がパラメータとして渡された。

注意

Microsoft® DirectX® 3 との互換性が必要な場合は、sizeof(DIDEVICEOBJECTINSTANCE_DX3) に初期化した dwSize メンバを含む DIDEVICEOBJECTINSTANCE_DX3 構造体を渡してもよい。