joySetCapture 関数 (ジョイスティックapi.h)

  • [アーティクル]

joySetCapture 関数は、メッセージを指定されたウィンドウに送信することによってジョイスティックをキャプチャします。

構文

MMRESULT joySetCapture(
  HWND hwnd,
  UINT uJoyID,
  UINT uPeriod,
  BOOL fChanged
);

パラメーター

hwnd

ウィンドウにハンドルしてジョイスティック メッセージを受信します。

uJoyID

キャプチャするジョイスティックの識別子。 uJoyID の有効な値の範囲は 0 (JOYSTICKID1) から 15 です。

uPeriod

ポーリング頻度 (ミリ秒単位)。

fChanged

位置フラグを変更します。 ジョイスティックの移動しきい値より大きい値で位置が変化した場合にのみメッセージを送信するには、このパラメーターに TRUE を 指定します。 それ以外の場合、 uPeriod で指定されたポーリング頻度でメッセージが送信されます。

戻り値

成功した場合JOYERR_NOERROR、または次のいずれかのエラー値を返します。

リターン コード 説明
MMSYSERR_NODRIVER
 ジョイスティック ドライバーが存在しません。
MMSYSERR_INVALPARAM
 ジョイスティック ID が無効であるか、hwnd が NULL です。
JOYERR_NOCANDO
 必要なサービス (Windows タイマーなど) が使用できないため、ジョイスティック入力をキャプチャできません。
JOYERR_UNPLUGGED
 指定されたジョイスティックがシステムに接続されていません。
JOYERR_PARMS
 ジョイスティック ID が無効であるか、hwnd が NULL です。

解説

指定したジョイスティックが現在キャプチャされている場合、関数は未定義の動作を返します。 joyReleaseCapture 関数を呼び出してキャプチャしたジョイスティックを解放するか、ウィンドウを破棄してジョイスティックを自動的に解放します。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ジョイスティックapi.h (Windows.h を含む)
Library Winmm.lib
[DLL] Winmm.dll

関連項目

ジョイスティック

マルチメディアジョイスティック機能