Win32 API 日本語リファレンス
ホームMedia.Multimedia › joyGetPos

joyGetPos

関数
ジョイスティックの位置とボタン状態を取得する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD joyGetPos(
    DWORD uJoyID,
    JOYINFO* pji
);

パラメーター

名前方向説明
uJoyIDDWORDin問い合わせるジョイスティックの識別子。uJoyID に指定できる有効な値は、0 (JOYSTICKID1) から 15 までの範囲です。
pjiJOYINFO*outジョイスティックの位置とボタンの状態を格納する JOYINFO 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

4 軸から 6 軸の動き、視点 (point-of-view) コントロール、または 4 つを超えるボタンを備えたデバイスの場合は、joyGetPosEx 関数を使用してください。

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

各言語での呼び出し定義

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

DWORD joyGetPos(
    DWORD uJoyID,
    JOYINFO* pji
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint joyGetPos(
    uint uJoyID,   // DWORD
    IntPtr pji   // JOYINFO* out
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function joyGetPos(
    uJoyID As UInteger,   ' DWORD
    pji As IntPtr   ' JOYINFO* out
) As UInteger
End Function
' uJoyID : DWORD
' pji : JOYINFO* out
Declare PtrSafe Function joyGetPos 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

joyGetPos = ctypes.windll.winmm.joyGetPos
joyGetPos.restype = wintypes.DWORD
joyGetPos.argtypes = [
    wintypes.DWORD,  # uJoyID : DWORD
    ctypes.c_void_p,  # pji : JOYINFO* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
joyGetPos = Fiddle::Function.new(
  lib['joyGetPos'],
  [
    -Fiddle::TYPE_INT,  # uJoyID : DWORD
    Fiddle::TYPE_VOIDP,  # pji : JOYINFO* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn joyGetPos(
        uJoyID: u32,  // DWORD
        pji: *mut JOYINFO  // JOYINFO* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint joyGetPos(uint uJoyID, IntPtr pji);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_joyGetPos' -Namespace Win32 -PassThru
# $api::joyGetPos(uJoyID, pji)
#uselib "WINMM.dll"
#func global joyGetPos "joyGetPos" sptr, sptr
; joyGetPos uJoyID, varptr(pji)   ; 戻り値は stat
; uJoyID : DWORD -> "sptr"
; pji : JOYINFO* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global joyGetPos "joyGetPos" int, var
; res = joyGetPos(uJoyID, pji)
; uJoyID : DWORD -> "int"
; pji : JOYINFO* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD joyGetPos(DWORD uJoyID, JOYINFO* pji)
#uselib "WINMM.dll"
#cfunc global joyGetPos "joyGetPos" int, var
; res = joyGetPos(uJoyID, pji)
; uJoyID : DWORD -> "int"
; pji : JOYINFO* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procjoyGetPos = winmm.NewProc("joyGetPos")
)

// uJoyID (DWORD), pji (JOYINFO* out)
r1, _, err := procjoyGetPos.Call(
	uintptr(uJoyID),
	uintptr(pji),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function joyGetPos(
  uJoyID: DWORD;   // DWORD
  pji: Pointer   // JOYINFO* out
): DWORD; stdcall;
  external 'WINMM.dll' name 'joyGetPos';
result := DllCall("WINMM\joyGetPos"
    , "UInt", uJoyID   ; DWORD
    , "Ptr", pji   ; JOYINFO* out
    , "UInt")   ; return: DWORD
●joyGetPos(uJoyID, pji) = DLL("WINMM.dll", "dword joyGetPos(dword, void*)")
# 呼び出し: joyGetPos(uJoyID, pji)
# uJoyID : DWORD -> "dword"
# pji : JOYINFO* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn joyGetPos(
    uJoyID: u32, // DWORD
    pji: [*c]JOYINFO // JOYINFO* out
) callconv(std.os.windows.WINAPI) u32;
proc joyGetPos(
    uJoyID: uint32,  # DWORD
    pji: ptr JOYINFO  # JOYINFO* out
): uint32 {.importc: "joyGetPos", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint joyGetPos(
    uint uJoyID,   // DWORD
    JOYINFO* pji   // JOYINFO* out
);
ccall((:joyGetPos, "WINMM.dll"), stdcall, UInt32,
      (UInt32, Ptr{JOYINFO}),
      uJoyID, pji)
# uJoyID : DWORD -> UInt32
# pji : JOYINFO* out -> Ptr{JOYINFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t joyGetPos(
    uint32_t uJoyID,
    void* pji);
]]
local winmm = ffi.load("winmm")
-- winmm.joyGetPos(uJoyID, pji)
-- uJoyID : DWORD
-- pji : JOYINFO* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const joyGetPos = lib.func('__stdcall', 'joyGetPos', 'uint32_t', ['uint32_t', 'void *']);
// joyGetPos(uJoyID, pji)
// uJoyID : DWORD -> 'uint32_t'
// pji : JOYINFO* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  joyGetPos: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.joyGetPos(uJoyID, pji)
// uJoyID : DWORD -> "u32"
// pji : JOYINFO* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t joyGetPos(
    uint32_t uJoyID,
    void* pji);
C, "WINMM.dll");
// $ffi->joyGetPos(uJoyID, pji);
// uJoyID : DWORD
// pji : JOYINFO* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winmm extends StdCallLibrary {
    Winmm INSTANCE = Native.load("winmm", Winmm.class);
    int joyGetPos(
        int uJoyID,   // DWORD
        Pointer pji   // JOYINFO* out
    );
}
@[Link("winmm")]
lib LibWINMM
  fun joyGetPos = joyGetPos(
    uJoyID : UInt32,   # DWORD
    pji : JOYINFO*   # JOYINFO* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef joyGetPosNative = Uint32 Function(Uint32, Pointer<Void>);
typedef joyGetPosDart = int Function(int, Pointer<Void>);
final joyGetPos = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<joyGetPosNative, joyGetPosDart>('joyGetPos');
// uJoyID : DWORD -> Uint32
// pji : JOYINFO* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function joyGetPos(
  uJoyID: DWORD;   // DWORD
  pji: Pointer   // JOYINFO* out
): DWORD; stdcall;
  external 'WINMM.dll' name 'joyGetPos';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "joyGetPos"
  c_joyGetPos :: Word32 -> Ptr () -> IO Word32
-- uJoyID : DWORD -> Word32
-- pji : JOYINFO* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let joygetpos =
  foreign "joyGetPos"
    (uint32_t @-> (ptr void) @-> returning uint32_t)
(* uJoyID : DWORD -> uint32_t *)
(* pji : JOYINFO* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("joyGetPos" joy-get-pos :convention :stdcall) :uint32
  (u-joy-id :uint32)   ; DWORD
  (pji :pointer))   ; JOYINFO* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $joyGetPos = Win32::API::More->new('WINMM',
    'DWORD joyGetPos(DWORD uJoyID, LPVOID pji)');
# my $ret = $joyGetPos->Call($uJoyID, $pji);
# uJoyID : DWORD -> DWORD
# pji : JOYINFO* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型