Win32 API 日本語リファレンス
ホームUI.Input.XboxController › XInputGetBatteryInformation

XInputGetBatteryInformation

関数
Xboxコントローラーのバッテリー情報を取得する。
DLLxinput1_4.dll呼出規約winapi

シグネチャ

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

DWORD XInputGetBatteryInformation(
    DWORD dwUserIndex,
    BATTERY_DEVTYPE devType,
    XINPUT_BATTERY_INFORMATION* pBatteryInformation
);

パラメーター

名前方向説明
dwUserIndexDWORDin対象コントローラーのインデックス(0〜3)を指定する。
devTypeBATTERY_DEVTYPEin情報取得対象。BATTERY_DEVTYPE_GAMEPADまたはBATTERY_DEVTYPE_HEADSETを指定する。
pBatteryInformationXINPUT_BATTERY_INFORMATION*out電池種別と残量を受け取るXINPUT_BATTERY_INFORMATION構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD XInputGetBatteryInformation(
    DWORD dwUserIndex,
    BATTERY_DEVTYPE devType,
    XINPUT_BATTERY_INFORMATION* pBatteryInformation
);
[DllImport("xinput1_4.dll", ExactSpelling = true)]
static extern uint XInputGetBatteryInformation(
    uint dwUserIndex,   // DWORD
    byte devType,   // BATTERY_DEVTYPE
    IntPtr pBatteryInformation   // XINPUT_BATTERY_INFORMATION* out
);
<DllImport("xinput1_4.dll", ExactSpelling:=True)>
Public Shared Function XInputGetBatteryInformation(
    dwUserIndex As UInteger,   ' DWORD
    devType As Byte,   ' BATTERY_DEVTYPE
    pBatteryInformation As IntPtr   ' XINPUT_BATTERY_INFORMATION* out
) As UInteger
End Function
' dwUserIndex : DWORD
' devType : BATTERY_DEVTYPE
' pBatteryInformation : XINPUT_BATTERY_INFORMATION* out
Declare PtrSafe Function XInputGetBatteryInformation Lib "xinput1_4" ( _
    ByVal dwUserIndex As Long, _
    ByVal devType As Byte, _
    ByVal pBatteryInformation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

XInputGetBatteryInformation = ctypes.windll.xinput1_4.XInputGetBatteryInformation
XInputGetBatteryInformation.restype = wintypes.DWORD
XInputGetBatteryInformation.argtypes = [
    wintypes.DWORD,  # dwUserIndex : DWORD
    ctypes.c_ubyte,  # devType : BATTERY_DEVTYPE
    ctypes.c_void_p,  # pBatteryInformation : XINPUT_BATTERY_INFORMATION* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	xinput1_4 = windows.NewLazySystemDLL("xinput1_4.dll")
	procXInputGetBatteryInformation = xinput1_4.NewProc("XInputGetBatteryInformation")
)

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

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

typedef XInputGetBatteryInformationNative = Uint32 Function(Uint32, Uint8, Pointer<Void>);
typedef XInputGetBatteryInformationDart = int Function(int, int, Pointer<Void>);
final XInputGetBatteryInformation = DynamicLibrary.open('xinput1_4.dll')
    .lookupFunction<XInputGetBatteryInformationNative, XInputGetBatteryInformationDart>('XInputGetBatteryInformation');
// dwUserIndex : DWORD -> Uint32
// devType : BATTERY_DEVTYPE -> Uint8
// pBatteryInformation : XINPUT_BATTERY_INFORMATION* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function XInputGetBatteryInformation(
  dwUserIndex: DWORD;   // DWORD
  devType: Byte;   // BATTERY_DEVTYPE
  pBatteryInformation: Pointer   // XINPUT_BATTERY_INFORMATION* out
): DWORD; stdcall;
  external 'xinput1_4.dll' name 'XInputGetBatteryInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "XInputGetBatteryInformation"
  c_XInputGetBatteryInformation :: Word32 -> Word8 -> Ptr () -> IO Word32
-- dwUserIndex : DWORD -> Word32
-- devType : BATTERY_DEVTYPE -> Word8
-- pBatteryInformation : XINPUT_BATTERY_INFORMATION* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let xinputgetbatteryinformation =
  foreign "XInputGetBatteryInformation"
    (uint32_t @-> uint8_t @-> (ptr void) @-> returning uint32_t)
(* dwUserIndex : DWORD -> uint32_t *)
(* devType : BATTERY_DEVTYPE -> uint8_t *)
(* pBatteryInformation : XINPUT_BATTERY_INFORMATION* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library xinput1_4 (t "xinput1_4.dll"))
(cffi:use-foreign-library xinput1_4)

(cffi:defcfun ("XInputGetBatteryInformation" xinput-get-battery-information :convention :stdcall) :uint32
  (dw-user-index :uint32)   ; DWORD
  (dev-type :uint8)   ; BATTERY_DEVTYPE
  (p-battery-information :pointer))   ; XINPUT_BATTERY_INFORMATION* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $XInputGetBatteryInformation = Win32::API::More->new('xinput1_4',
    'DWORD XInputGetBatteryInformation(DWORD dwUserIndex, BYTE devType, LPVOID pBatteryInformation)');
# my $ret = $XInputGetBatteryInformation->Call($dwUserIndex, $devType, $pBatteryInformation);
# dwUserIndex : DWORD -> DWORD
# devType : BATTERY_DEVTYPE -> BYTE
# pBatteryInformation : XINPUT_BATTERY_INFORMATION* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型