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

joySetCapture

関数
ジョイスティックメッセージを指定ウィンドウに捕捉させる。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD joySetCapture(
    HWND hwnd,
    DWORD uJoyID,
    DWORD uPeriod,
    BOOL fChanged
);

パラメーター

名前方向説明
hwndHWNDinジョイスティックのメッセージを受信するウィンドウへのハンドル。
uJoyIDDWORDinキャプチャするジョイスティックの識別子。uJoyID に指定できる有効な値は、0 (JOYSTICKID1) から 15 までです。
uPeriodDWORDinポーリング頻度 (ミリ秒単位)。
fChangedBOOLin位置変化フラグ。このパラメーターに TRUE を指定すると、位置の変化がジョイスティックの移動しきい値を超えた場合にのみメッセージが送信されます。それ以外の場合、メッセージは uPeriod で指定したポーリング頻度で送信されます。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

DWORD joySetCapture(
    HWND hwnd,
    DWORD uJoyID,
    DWORD uPeriod,
    BOOL fChanged
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint joySetCapture(
    IntPtr hwnd,   // HWND
    uint uJoyID,   // DWORD
    uint uPeriod,   // DWORD
    bool fChanged   // BOOL
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function joySetCapture(
    hwnd As IntPtr,   ' HWND
    uJoyID As UInteger,   ' DWORD
    uPeriod As UInteger,   ' DWORD
    fChanged As Boolean   ' BOOL
) As UInteger
End Function
' hwnd : HWND
' uJoyID : DWORD
' uPeriod : DWORD
' fChanged : BOOL
Declare PtrSafe Function joySetCapture Lib "winmm" ( _
    ByVal hwnd As LongPtr, _
    ByVal uJoyID As Long, _
    ByVal uPeriod As Long, _
    ByVal fChanged As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

joySetCapture = ctypes.windll.winmm.joySetCapture
joySetCapture.restype = wintypes.DWORD
joySetCapture.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.DWORD,  # uJoyID : DWORD
    wintypes.DWORD,  # uPeriod : DWORD
    wintypes.BOOL,  # fChanged : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
joySetCapture = Fiddle::Function.new(
  lib['joySetCapture'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    -Fiddle::TYPE_INT,  # uJoyID : DWORD
    -Fiddle::TYPE_INT,  # uPeriod : DWORD
    Fiddle::TYPE_INT,  # fChanged : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn joySetCapture(
        hwnd: *mut core::ffi::c_void,  // HWND
        uJoyID: u32,  // DWORD
        uPeriod: u32,  // DWORD
        fChanged: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint joySetCapture(IntPtr hwnd, uint uJoyID, uint uPeriod, bool fChanged);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_joySetCapture' -Namespace Win32 -PassThru
# $api::joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
#uselib "WINMM.dll"
#func global joySetCapture "joySetCapture" sptr, sptr, sptr, sptr
; joySetCapture hwnd, uJoyID, uPeriod, fChanged   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; uJoyID : DWORD -> "sptr"
; uPeriod : DWORD -> "sptr"
; fChanged : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global joySetCapture "joySetCapture" sptr, int, int, int
; res = joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
; hwnd : HWND -> "sptr"
; uJoyID : DWORD -> "int"
; uPeriod : DWORD -> "int"
; fChanged : BOOL -> "int"
; DWORD joySetCapture(HWND hwnd, DWORD uJoyID, DWORD uPeriod, BOOL fChanged)
#uselib "WINMM.dll"
#cfunc global joySetCapture "joySetCapture" intptr, int, int, int
; res = joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
; hwnd : HWND -> "intptr"
; uJoyID : DWORD -> "int"
; uPeriod : DWORD -> "int"
; fChanged : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procjoySetCapture = winmm.NewProc("joySetCapture")
)

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

extern "winmm" fn joySetCapture(
    hwnd: ?*anyopaque, // HWND
    uJoyID: u32, // DWORD
    uPeriod: u32, // DWORD
    fChanged: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc joySetCapture(
    hwnd: pointer,  # HWND
    uJoyID: uint32,  # DWORD
    uPeriod: uint32,  # DWORD
    fChanged: int32  # BOOL
): uint32 {.importc: "joySetCapture", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint joySetCapture(
    void* hwnd,   // HWND
    uint uJoyID,   // DWORD
    uint uPeriod,   // DWORD
    int fChanged   // BOOL
);
ccall((:joySetCapture, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, UInt32, Int32),
      hwnd, uJoyID, uPeriod, fChanged)
# hwnd : HWND -> Ptr{Cvoid}
# uJoyID : DWORD -> UInt32
# uPeriod : DWORD -> UInt32
# fChanged : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t joySetCapture(
    void* hwnd,
    uint32_t uJoyID,
    uint32_t uPeriod,
    int32_t fChanged);
]]
local winmm = ffi.load("winmm")
-- winmm.joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
-- hwnd : HWND
-- uJoyID : DWORD
-- uPeriod : DWORD
-- fChanged : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const joySetCapture = lib.func('__stdcall', 'joySetCapture', 'uint32_t', ['void *', 'uint32_t', 'uint32_t', 'int32_t']);
// joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
// hwnd : HWND -> 'void *'
// uJoyID : DWORD -> 'uint32_t'
// uPeriod : DWORD -> 'uint32_t'
// fChanged : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  joySetCapture: { parameters: ["pointer", "u32", "u32", "i32"], result: "u32" },
});
// lib.symbols.joySetCapture(hwnd, uJoyID, uPeriod, fChanged)
// hwnd : HWND -> "pointer"
// uJoyID : DWORD -> "u32"
// uPeriod : DWORD -> "u32"
// fChanged : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t joySetCapture(
    void* hwnd,
    uint32_t uJoyID,
    uint32_t uPeriod,
    int32_t fChanged);
C, "WINMM.dll");
// $ffi->joySetCapture(hwnd, uJoyID, uPeriod, fChanged);
// hwnd : HWND
// uJoyID : DWORD
// uPeriod : DWORD
// fChanged : BOOL
// 構造体/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 joySetCapture(
        Pointer hwnd,   // HWND
        int uJoyID,   // DWORD
        int uPeriod,   // DWORD
        boolean fChanged   // BOOL
    );
}
@[Link("winmm")]
lib LibWINMM
  fun joySetCapture = joySetCapture(
    hwnd : Void*,   # HWND
    uJoyID : UInt32,   # DWORD
    uPeriod : UInt32,   # DWORD
    fChanged : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef joySetCaptureNative = Uint32 Function(Pointer<Void>, Uint32, Uint32, Int32);
typedef joySetCaptureDart = int Function(Pointer<Void>, int, int, int);
final joySetCapture = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<joySetCaptureNative, joySetCaptureDart>('joySetCapture');
// hwnd : HWND -> Pointer<Void>
// uJoyID : DWORD -> Uint32
// uPeriod : DWORD -> Uint32
// fChanged : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function joySetCapture(
  hwnd: THandle;   // HWND
  uJoyID: DWORD;   // DWORD
  uPeriod: DWORD;   // DWORD
  fChanged: BOOL   // BOOL
): DWORD; stdcall;
  external 'WINMM.dll' name 'joySetCapture';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "joySetCapture"
  c_joySetCapture :: Ptr () -> Word32 -> Word32 -> CInt -> IO Word32
-- hwnd : HWND -> Ptr ()
-- uJoyID : DWORD -> Word32
-- uPeriod : DWORD -> Word32
-- fChanged : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let joysetcapture =
  foreign "joySetCapture"
    ((ptr void) @-> uint32_t @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hwnd : HWND -> (ptr void) *)
(* uJoyID : DWORD -> uint32_t *)
(* uPeriod : DWORD -> uint32_t *)
(* fChanged : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("joySetCapture" joy-set-capture :convention :stdcall) :uint32
  (hwnd :pointer)   ; HWND
  (u-joy-id :uint32)   ; DWORD
  (u-period :uint32)   ; DWORD
  (f-changed :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $joySetCapture = Win32::API::More->new('WINMM',
    'DWORD joySetCapture(HANDLE hwnd, DWORD uJoyID, DWORD uPeriod, BOOL fChanged)');
# my $ret = $joySetCapture->Call($hwnd, $uJoyID, $uPeriod, $fChanged);
# hwnd : HWND -> HANDLE
# uJoyID : DWORD -> DWORD
# uPeriod : DWORD -> DWORD
# fChanged : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。