Microsoft DirectX 8.0 (C++)

IDirectInputDevice8::GetForceFeedbackState

デバイスのフォース フィードバック システムの状態を取得する。

HRESULT GetForceFeedbackState(
  LPDWORD pdwOut  
);

パラメータ

pdwOut
デバイスのフォース フィードバック システムの現在の状態を表すフラグのアドレス。

この値は、以下の定数の組み合わせである。

DIGFFS_ACTUATORSOFF
デバイスのフォース フィードバック アクチュエータが無効である。
DIGFFS_ACTUATORSON
デバイスのフォース フィードバック アクチュエータが有効である。
DIGFFS_DEVICELOST
デバイスが予期しない障害を被り、不確定な状態にある。一度デバイスを解放した後で再取得するか、または DISFFC_RESET コマンドを送信するかどちらかでデバイスをリセットしなければならない。
DIGFFS_EMPTY
デバイスはダウンロードされた要素を持たない。
DIGFFS_PAUSED
すべてのアクティブなエフェクトの再生が一時停止されている。
DIGFFS_POWEROFF
フォース フィードバック システムは、現在使用できない。デバイスが電源状態を報告できなければ、DIFFS_POWERON および DIFFS_POWEROFF のどちらも返されない。
DIGFFS_POWERON
フォース フィードバック システムの電源は現在入っている。デバイスが電源状態を報告できなければ、DIFFS_POWERON および DIFFS_POWEROFF のどちらも返されない。
DIGFFS_SAFETYSWITCHOFF
安全スイッチが現在オフである。つまり、デバイスは動作できない。デバイスが安全スイッチの状態を報告できなければ、DIFFS_SAFETYSWITCHON と DIFFS_SAFETYSWITCHOFF のどちらも返されない。
DIGFFS_SAFETYSWITCHON
安全スイッチが現在オンである。つまり、デバイスは動作できる。デバイスが安全スイッチの状態を報告できなければ、DIFFS_SAFETYSWITCHON と DIFFS_SAFETYSWITCHOFF のどちらも返されない。
DIGFFS_STOPPED
再生中のエフェクトはなく、デバイスは中断状態ではない。
DIGFFS_USERFFSWITCHOFF
ユーザー フォース フィードバック スイッチが現在オフである。つまり、デバイスは動作できない。デバイスがユーザー フォース フィードバック スイッチの状態を報告できなければ、DIFFS_USERFFSWITCHON と DIFFS_USERFFSWITCHOFF のどちらも返されない。
DIGFFS_USERFFSWITCHON
ユーザー フォース フィードバック スイッチが現在オンである。つまり、デバイスは動作できる。デバイスがユーザー フォース フィードバック スイッチの状態を報告できなければ、DIFFS_USERFFSWITCHON と DIFFS_USERFFSWITCHOFF のどちらも返されない。

Microsoft® DirectInput® の将来のバージョンで、フラグが追加定義される可能性もある。アプリケーションは、現在未定義のフラグをすべて無視する必要がある。

戻り値

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

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

DIERR_INPUTLOST
DIERR_INVALIDPARAM
DIERR_NOTEXCLUSIVEACQUIRED
DIERR_NOTINITIALIZED
DIERR_UNSUPPORTED

注意

このメソッドを成功させるには、デバイスを排他協調レベルで取得しなければならない。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : dinput.h で宣言。