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

joyGetDevCapsW

関数
ジョイスティックの能力情報を取得する(Unicode版)。
DLLWINMM.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD joyGetDevCapsW(
    UINT_PTR uJoyID,
    JOYCAPSW* pjc,
    DWORD cbjc
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

メモ

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

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

各言語での呼び出し定義

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD joyGetDevCapsW(
    UINT_PTR uJoyID,
    JOYCAPSW* pjc,
    DWORD cbjc
);
[DllImport("WINMM.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint joyGetDevCapsW(
    UIntPtr uJoyID,   // UINT_PTR
    IntPtr pjc,   // JOYCAPSW* out
    uint cbjc   // DWORD
);
<DllImport("WINMM.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function joyGetDevCapsW(
    uJoyID As UIntPtr,   ' UINT_PTR
    pjc As IntPtr,   ' JOYCAPSW* out
    cbjc As UInteger   ' DWORD
) As UInteger
End Function
' uJoyID : UINT_PTR
' pjc : JOYCAPSW* out
' cbjc : DWORD
Declare PtrSafe Function joyGetDevCapsW Lib "winmm" ( _
    ByVal uJoyID As LongPtr, _
    ByVal pjc As LongPtr, _
    ByVal cbjc As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

joyGetDevCapsW = ctypes.windll.winmm.joyGetDevCapsW
joyGetDevCapsW.restype = wintypes.DWORD
joyGetDevCapsW.argtypes = [
    ctypes.c_size_t,  # uJoyID : UINT_PTR
    ctypes.c_void_p,  # pjc : JOYCAPSW* out
    wintypes.DWORD,  # cbjc : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procjoyGetDevCapsW = winmm.NewProc("joyGetDevCapsW")
)

// uJoyID (UINT_PTR), pjc (JOYCAPSW* out), cbjc (DWORD)
r1, _, err := procjoyGetDevCapsW.Call(
	uintptr(uJoyID),
	uintptr(pjc),
	uintptr(cbjc),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function joyGetDevCapsW(
  uJoyID: NativeUInt;   // UINT_PTR
  pjc: Pointer;   // JOYCAPSW* out
  cbjc: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'joyGetDevCapsW';
result := DllCall("WINMM\joyGetDevCapsW"
    , "UPtr", uJoyID   ; UINT_PTR
    , "Ptr", pjc   ; JOYCAPSW* out
    , "UInt", cbjc   ; DWORD
    , "UInt")   ; return: DWORD
●joyGetDevCapsW(uJoyID, pjc, cbjc) = DLL("WINMM.dll", "dword joyGetDevCapsW(int, void*, dword)")
# 呼び出し: joyGetDevCapsW(uJoyID, pjc, cbjc)
# uJoyID : UINT_PTR -> "int"
# pjc : JOYCAPSW* out -> "void*"
# cbjc : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winmm" fn joyGetDevCapsW(
    uJoyID: usize, // UINT_PTR
    pjc: [*c]JOYCAPSW, // JOYCAPSW* out
    cbjc: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc joyGetDevCapsW(
    uJoyID: uint,  # UINT_PTR
    pjc: ptr JOYCAPSW,  # JOYCAPSW* out
    cbjc: uint32  # DWORD
): uint32 {.importc: "joyGetDevCapsW", stdcall, dynlib: "WINMM.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winmm");
extern(Windows)
uint joyGetDevCapsW(
    size_t uJoyID,   // UINT_PTR
    JOYCAPSW* pjc,   // JOYCAPSW* out
    uint cbjc   // DWORD
);
ccall((:joyGetDevCapsW, "WINMM.dll"), stdcall, UInt32,
      (Csize_t, Ptr{JOYCAPSW}, UInt32),
      uJoyID, pjc, cbjc)
# uJoyID : UINT_PTR -> Csize_t
# pjc : JOYCAPSW* out -> Ptr{JOYCAPSW}
# cbjc : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t joyGetDevCapsW(
    uintptr_t uJoyID,
    void* pjc,
    uint32_t cbjc);
]]
local winmm = ffi.load("winmm")
-- winmm.joyGetDevCapsW(uJoyID, pjc, cbjc)
-- uJoyID : UINT_PTR
-- pjc : JOYCAPSW* out
-- cbjc : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const joyGetDevCapsW = lib.func('__stdcall', 'joyGetDevCapsW', 'uint32_t', ['uintptr_t', 'void *', 'uint32_t']);
// joyGetDevCapsW(uJoyID, pjc, cbjc)
// uJoyID : UINT_PTR -> 'uintptr_t'
// pjc : JOYCAPSW* out -> 'void *'
// cbjc : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  joyGetDevCapsW: { parameters: ["usize", "pointer", "u32"], result: "u32" },
});
// lib.symbols.joyGetDevCapsW(uJoyID, pjc, cbjc)
// uJoyID : UINT_PTR -> "usize"
// pjc : JOYCAPSW* out -> "pointer"
// cbjc : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t joyGetDevCapsW(
    size_t uJoyID,
    void* pjc,
    uint32_t cbjc);
C, "WINMM.dll");
// $ffi->joyGetDevCapsW(uJoyID, pjc, cbjc);
// uJoyID : UINT_PTR
// pjc : JOYCAPSW* out
// cbjc : DWORD
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int joyGetDevCapsW(
        long uJoyID,   // UINT_PTR
        Pointer pjc,   // JOYCAPSW* out
        int cbjc   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winmm")]
lib LibWINMM
  fun joyGetDevCapsW = joyGetDevCapsW(
    uJoyID : LibC::SizeT,   # UINT_PTR
    pjc : JOYCAPSW*,   # JOYCAPSW* out
    cbjc : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("joyGetDevCapsW" joy-get-dev-caps-w :convention :stdcall) :uint32
  (u-joy-id :uint64)   ; UINT_PTR
  (pjc :pointer)   ; JOYCAPSW* out
  (cbjc :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $joyGetDevCapsW = Win32::API::More->new('WINMM',
    'DWORD joyGetDevCapsW(WPARAM uJoyID, LPVOID pjc, DWORD cbjc)');
# my $ret = $joyGetDevCapsW->Call($uJoyID, $pjc, $cbjc);
# uJoyID : UINT_PTR -> WPARAM
# pjc : JOYCAPSW* out -> LPVOID
# cbjc : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型