IDirectInputEffect::Initialize メソッド

IDirectInputEffect::Initialize メソッド

DirectInputEffect オブジェクトを初期化する。

構文

HRESULT Initialize(      
    HINSTANCE hinst,
    DWORD dwVersion,
    REFGUID rguid
);

パラメータ

• hinst
  DirectInputEffect オブジェクトを作成するアプリケーションまたは DLL のインスタンス ハンドル。Microsoft® DirectInput® は、この値を使って、アプリケーションまたは DLL が認定されているかどうかを判断すると共に、下位互換性のために必要な動作を確立する。DLL が親のアプリケーションのハンドルを渡すとエラーとなる。
• dwVersion
  アプリケーションの設計対象である DirectInput のバージョン番号。この値は通常、DIRECTINPUT_VERSION である。以前のバージョン番号を渡すと、DirectInput がそのバージョンをエミュレートする。
• rguid
  インターフェイスに関連付けられたエフェクトを識別する、グローバル一意識別子 (GUID) のアドレス。IDirectInputDevice8::EnumEffectsメソッドを使って、デバイスがどのエフェクト GUID をサポートしているかを確認できる。

戻り値

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

失敗した場合は、DIERR_DEVICENOTREG を返す。

注意

このメソッドが失敗する場合、基になるオブジェクトは不定の状態にあるものと見なされるので、再初期化しないと、それ以降に使えない。

このメソッドが成功した場合、すべてのエフェクト パラメータは無効になる。エフェクトをダウンロードまたは開始する前に、IDirectInputEffect::SetParameters を呼び出す必要がある。

IDirectInputDevice8::CreateEffect メソッドは、エフェクトを作成した後に自動的に初期化する。通常、アプリケーションは IDirectInputEffect::Initialize メソッドを呼び出す必要はない。