joyGetDevCapsA

関数

ジョイスティックの能力情報を取得する(ANSI版)。

DLLWINMM.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD joyGetDevCapsA(
    UINT_PTR uJoyID,
    JOYCAPSA* pjc,
    DWORD cbjc
);

パラメーター

名前	型	方向	説明
uJoyID	UINT_PTR	in	問い合わせ対象のジョイスティックの識別子。uJoyID に指定できる値の範囲は -1 から 15 です。値 -1 を指定すると、デバイスの有無にかかわらず JOYCAPS 構造体の szRegKey メンバーを取得できます。
pjc	JOYCAPSA*	out	ジョイスティックの機能を格納する JOYCAPS 構造体へのポインター。
cbjc	DWORD	in	JOYCAPS 構造体のサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

joyGetDevCaps 関数は、ジョイスティックに問い合わせてその機能を取得します。(joyGetDevCapsA)

戻り値

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

戻り値	説明
MMSYSERR_NODRIVER	ジョイスティックドライバーが存在しないか、指定されたジョイスティック識別子が無効です。指定されたジョイスティック識別子が無効です。
MMSYSERR_INVALPARAM	無効なパラメーターが渡されました。

解説(Remarks)

ドライバーがサポートするジョイスティックデバイスの数を調べるには、joyGetNumDevs 関数を使用します。

このメソッドは、cbjc パラメーターに無効な値が渡された場合に失敗します。

メモ

joystickapi.h ヘッダーは joyGetDevCaps を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、Conventions for Function Prototypesを参照してください。

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

各言語での呼び出し定義

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD joyGetDevCapsA(
    UINT_PTR uJoyID,
    JOYCAPSA* pjc,
    DWORD cbjc
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint joyGetDevCapsA(
    UIntPtr uJoyID,   // UINT_PTR
    IntPtr pjc,   // JOYCAPSA* out
    uint cbjc   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function joyGetDevCapsA(
    uJoyID As UIntPtr,   ' UINT_PTR
    pjc As IntPtr,   ' JOYCAPSA* out
    cbjc As UInteger   ' DWORD
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

joyGetDevCapsA = ctypes.windll.winmm.joyGetDevCapsA
joyGetDevCapsA.restype = wintypes.DWORD
joyGetDevCapsA.argtypes = [
    ctypes.c_size_t,  # uJoyID : UINT_PTR
    ctypes.c_void_p,  # pjc : JOYCAPSA* out
    wintypes.DWORD,  # cbjc : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
joyGetDevCapsA = Fiddle::Function.new(
  lib['joyGetDevCapsA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # uJoyID : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pjc : JOYCAPSA* out
    -Fiddle::TYPE_INT,  # cbjc : DWORD
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Ansi)]
public static extern uint joyGetDevCapsA(UIntPtr uJoyID, IntPtr pjc, uint cbjc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_joyGetDevCapsA' -Namespace Win32 -PassThru
# $api::joyGetDevCapsA(uJoyID, pjc, cbjc)

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

出力引数:

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