Win32 API 日本語リファレンス
ホームDevices.HumanInterfaceDevice › HidD_GetSerialNumberString

HidD_GetSerialNumberString

関数
HIDデバイスのシリアル番号文字列を取得する。
DLLHID.dll呼出規約winapi

シグネチャ

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

BOOLEAN HidD_GetSerialNumberString(
    HANDLE HidDeviceObject,
    void* Buffer,
    DWORD BufferLength
);

パラメーター

名前方向説明
HidDeviceObjectHANDLEin対象HIDデバイスへのオープン済みハンドル。
Buffervoid*outシリアル番号文字列を受け取るバッファへのポインタ。NULL終端のワイド文字列が返る。
BufferLengthDWORDinBufferのサイズをバイト単位で指定する。

戻り値の型: BOOLEAN

各言語での呼び出し定義

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

BOOLEAN HidD_GetSerialNumberString(
    HANDLE HidDeviceObject,
    void* Buffer,
    DWORD BufferLength
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("HID.dll", ExactSpelling = true)]
static extern bool HidD_GetSerialNumberString(
    IntPtr HidDeviceObject,   // HANDLE
    IntPtr Buffer,   // void* out
    uint BufferLength   // DWORD
);
<DllImport("HID.dll", ExactSpelling:=True)>
Public Shared Function HidD_GetSerialNumberString(
    HidDeviceObject As IntPtr,   ' HANDLE
    Buffer As IntPtr,   ' void* out
    BufferLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' HidDeviceObject : HANDLE
' Buffer : void* out
' BufferLength : DWORD
Declare PtrSafe Function HidD_GetSerialNumberString Lib "hid" ( _
    ByVal HidDeviceObject As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLength As Long) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HidD_GetSerialNumberString = ctypes.windll.hid.HidD_GetSerialNumberString
HidD_GetSerialNumberString.restype = wintypes.BOOLEAN
HidD_GetSerialNumberString.argtypes = [
    wintypes.HANDLE,  # HidDeviceObject : HANDLE
    ctypes.POINTER(None),  # Buffer : void* out
    wintypes.DWORD,  # BufferLength : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HID.dll')
HidD_GetSerialNumberString = Fiddle::Function.new(
  lib['HidD_GetSerialNumberString'],
  [
    Fiddle::TYPE_VOIDP,  # HidDeviceObject : HANDLE
    Fiddle::TYPE_VOIDP,  # Buffer : void* out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "hid")]
extern "system" {
    fn HidD_GetSerialNumberString(
        HidDeviceObject: *mut core::ffi::c_void,  // HANDLE
        Buffer: *mut (),  // void* out
        BufferLength: u32  // DWORD
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("HID.dll")]
public static extern bool HidD_GetSerialNumberString(IntPtr HidDeviceObject, IntPtr Buffer, uint BufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HID_HidD_GetSerialNumberString' -Namespace Win32 -PassThru
# $api::HidD_GetSerialNumberString(HidDeviceObject, Buffer, BufferLength)
#uselib "HID.dll"
#func global HidD_GetSerialNumberString "HidD_GetSerialNumberString" sptr, sptr, sptr
; HidD_GetSerialNumberString HidDeviceObject, Buffer, BufferLength   ; 戻り値は stat
; HidDeviceObject : HANDLE -> "sptr"
; Buffer : void* out -> "sptr"
; BufferLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "HID.dll"
#cfunc global HidD_GetSerialNumberString "HidD_GetSerialNumberString" sptr, sptr, int
; res = HidD_GetSerialNumberString(HidDeviceObject, Buffer, BufferLength)
; HidDeviceObject : HANDLE -> "sptr"
; Buffer : void* out -> "sptr"
; BufferLength : DWORD -> "int"
; BOOLEAN HidD_GetSerialNumberString(HANDLE HidDeviceObject, void* Buffer, DWORD BufferLength)
#uselib "HID.dll"
#cfunc global HidD_GetSerialNumberString "HidD_GetSerialNumberString" intptr, intptr, int
; res = HidD_GetSerialNumberString(HidDeviceObject, Buffer, BufferLength)
; HidDeviceObject : HANDLE -> "intptr"
; Buffer : void* out -> "intptr"
; BufferLength : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	hid = windows.NewLazySystemDLL("HID.dll")
	procHidD_GetSerialNumberString = hid.NewProc("HidD_GetSerialNumberString")
)

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

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

typedef HidD_GetSerialNumberStringNative = Uint8 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef HidD_GetSerialNumberStringDart = int Function(Pointer<Void>, Pointer<Void>, int);
final HidD_GetSerialNumberString = DynamicLibrary.open('HID.dll')
    .lookupFunction<HidD_GetSerialNumberStringNative, HidD_GetSerialNumberStringDart>('HidD_GetSerialNumberString');
// HidDeviceObject : HANDLE -> Pointer<Void>
// Buffer : void* out -> Pointer<Void>
// BufferLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HidD_GetSerialNumberString(
  HidDeviceObject: THandle;   // HANDLE
  Buffer: Pointer;   // void* out
  BufferLength: DWORD   // DWORD
): ByteBool; stdcall;
  external 'HID.dll' name 'HidD_GetSerialNumberString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HidD_GetSerialNumberString"
  c_HidD_GetSerialNumberString :: Ptr () -> Ptr () -> Word32 -> IO Word8
-- HidDeviceObject : HANDLE -> Ptr ()
-- Buffer : void* out -> Ptr ()
-- BufferLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hidd_getserialnumberstring =
  foreign "HidD_GetSerialNumberString"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning uint8_t)
(* HidDeviceObject : HANDLE -> (ptr void) *)
(* Buffer : void* out -> (ptr void) *)
(* BufferLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hid (t "HID.dll"))
(cffi:use-foreign-library hid)

(cffi:defcfun ("HidD_GetSerialNumberString" hid-d-get-serial-number-string :convention :stdcall) :uint8
  (hid-device-object :pointer)   ; HANDLE
  (buffer :pointer)   ; void* out
  (buffer-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HidD_GetSerialNumberString = Win32::API::More->new('HID',
    'BYTE HidD_GetSerialNumberString(HANDLE HidDeviceObject, LPVOID Buffer, DWORD BufferLength)');
# my $ret = $HidD_GetSerialNumberString->Call($HidDeviceObject, $Buffer, $BufferLength);
# HidDeviceObject : HANDLE -> HANDLE
# Buffer : void* out -> LPVOID
# BufferLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。