joyGetPosEx

関数

ジョイスティックの拡張位置と状態を取得する。

DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WINMM.dll
#include <windows.h>

DWORD joyGetPosEx(
    DWORD uJoyID,
    JOYINFOEX* pji
);

パラメーター

名前	型	方向	説明
uJoyID	DWORD	in	問い合わせ対象のジョイスティックの識別子。uJoyID の有効な値は 0 (JOYSTICKID1) から 15 までの範囲です。
pji	JOYINFOEX*	out	ジョイスティックの拡張位置情報とボタンの状態を格納する JOYINFOEX 構造体へのポインター。dwSize メンバーと dwFlags メンバーを設定する必要があります。設定しない場合、joyGetPosEx は失敗します。joyGetPosEx から返される情報は、dwFlags に指定したフラグによって異なります。

戻り値の型: DWORD

公式ドキュメント

joyGetPosEx 関数は、ジョイスティックに対してその位置とボタンの状態を問い合わせます。

戻り値

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

戻り値	説明
MMSYSERR_NODRIVER	ジョイスティックドライバーが存在しません。
MMSYSERR_INVALPARAM	無効なパラメーターが渡されました。
MMSYSERR_BADDEVICEID	指定されたジョイスティック識別子が無効です。
JOYERR_UNPLUGGED	指定されたジョイスティックがシステムに接続されていません。
JOYERR_PARMS	指定されたジョイスティック識別子が無効です。

解説(Remarks)

この関数は、ラダーペダル、ポイントオブビューハット、多数のボタンを備えたデバイス、最大 6 軸を使用する座標系といった拡張デバイスへのアクセスを提供します。3 軸以下かつ 4 個未満のボタンを使用するジョイスティックデバイスには、joyGetPos 関数を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WINMM.dll
#include <windows.h>

DWORD joyGetPosEx(
    DWORD uJoyID,
    JOYINFOEX* pji
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint joyGetPosEx(
    uint uJoyID,   // DWORD
    IntPtr pji   // JOYINFOEX* out
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function joyGetPosEx(
    uJoyID As UInteger,   ' DWORD
    pji As IntPtr   ' JOYINFOEX* out
) As UInteger
End Function

' uJoyID : DWORD
' pji : JOYINFOEX* out
Declare PtrSafe Function joyGetPosEx Lib "winmm" ( _
    ByVal uJoyID As Long, _
    ByVal pji As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

joyGetPosEx = ctypes.windll.winmm.joyGetPosEx
joyGetPosEx.restype = wintypes.DWORD
joyGetPosEx.argtypes = [
    wintypes.DWORD,  # uJoyID : DWORD
    ctypes.c_void_p,  # pji : JOYINFOEX* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
joyGetPosEx = Fiddle::Function.new(
  lib['joyGetPosEx'],
  [
    -Fiddle::TYPE_INT,  # uJoyID : DWORD
    Fiddle::TYPE_VOIDP,  # pji : JOYINFOEX* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn joyGetPosEx(
        uJoyID: u32,  // DWORD
        pji: *mut JOYINFOEX  // JOYINFOEX* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint joyGetPosEx(uint uJoyID, IntPtr pji);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_joyGetPosEx' -Namespace Win32 -PassThru
# $api::joyGetPosEx(uJoyID, pji)

#uselib "WINMM.dll"
#func global joyGetPosEx "joyGetPosEx" sptr, sptr
; joyGetPosEx uJoyID, varptr(pji)   ; 戻り値は stat
; uJoyID : DWORD -> "sptr"
; pji : JOYINFOEX* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global joyGetPosEx "joyGetPosEx" int, var
; res = joyGetPosEx(uJoyID, pji)
; uJoyID : DWORD -> "int"
; pji : JOYINFOEX* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global joyGetPosEx "joyGetPosEx" int, sptr
; res = joyGetPosEx(uJoyID, varptr(pji))
; uJoyID : DWORD -> "int"
; pji : JOYINFOEX* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。