ホーム › Devices.BiometricFramework › WinBioControlUnit

WinBioControlUnit

関数

生体認証ユニットへ制御コマンドを送信し応答を受け取る。

DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioControlUnit(
    DWORD SessionHandle,
    DWORD UnitId,
    WINBIO_COMPONENT Component,
    DWORD ControlCode,
    BYTE* SendBuffer,
    UINT_PTR SendBufferSize,
    BYTE* ReceiveBuffer,
    UINT_PTR ReceiveBufferSize,
    UINT_PTR* ReceiveDataSize,
    DWORD* OperationStatus   // optional
);

パラメーター

名前	型	方向
SessionHandle	DWORD	in
UnitId	DWORD	in
Component	WINBIO_COMPONENT	in
ControlCode	DWORD	in
SendBuffer	BYTE*	in
SendBufferSize	UINT_PTR	in
ReceiveBuffer	BYTE*	out
ReceiveBufferSize	UINT_PTR	in
ReceiveDataSize	UINT_PTR*	inout
OperationStatus	DWORD*	outoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WinBioControlUnit(
    DWORD SessionHandle,
    DWORD UnitId,
    WINBIO_COMPONENT Component,
    DWORD ControlCode,
    BYTE* SendBuffer,
    UINT_PTR SendBufferSize,
    BYTE* ReceiveBuffer,
    UINT_PTR ReceiveBufferSize,
    UINT_PTR* ReceiveDataSize,
    DWORD* OperationStatus   // optional
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioControlUnit(
    uint SessionHandle,   // DWORD
    uint UnitId,   // DWORD
    uint Component,   // WINBIO_COMPONENT
    uint ControlCode,   // DWORD
    IntPtr SendBuffer,   // BYTE*
    UIntPtr SendBufferSize,   // UINT_PTR
    IntPtr ReceiveBuffer,   // BYTE* out
    UIntPtr ReceiveBufferSize,   // UINT_PTR
    ref UIntPtr ReceiveDataSize,   // UINT_PTR* in/out
    IntPtr OperationStatus   // DWORD* optional, out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioControlUnit(
    SessionHandle As UInteger,   ' DWORD
    UnitId As UInteger,   ' DWORD
    Component As UInteger,   ' WINBIO_COMPONENT
    ControlCode As UInteger,   ' DWORD
    SendBuffer As IntPtr,   ' BYTE*
    SendBufferSize As UIntPtr,   ' UINT_PTR
    ReceiveBuffer As IntPtr,   ' BYTE* out
    ReceiveBufferSize As UIntPtr,   ' UINT_PTR
    ByRef ReceiveDataSize As UIntPtr,   ' UINT_PTR* in/out
    OperationStatus As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' SessionHandle : DWORD
' UnitId : DWORD
' Component : WINBIO_COMPONENT
' ControlCode : DWORD
' SendBuffer : BYTE*
' SendBufferSize : UINT_PTR
' ReceiveBuffer : BYTE* out
' ReceiveBufferSize : UINT_PTR
' ReceiveDataSize : UINT_PTR* in/out
' OperationStatus : DWORD* optional, out
Declare PtrSafe Function WinBioControlUnit Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal UnitId As Long, _
    ByVal Component As Long, _
    ByVal ControlCode As Long, _
    ByVal SendBuffer As LongPtr, _
    ByVal SendBufferSize As LongPtr, _
    ByVal ReceiveBuffer As LongPtr, _
    ByVal ReceiveBufferSize As LongPtr, _
    ByRef ReceiveDataSize As LongPtr, _
    ByVal OperationStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinBioControlUnit = ctypes.windll.winbio.WinBioControlUnit
WinBioControlUnit.restype = ctypes.c_int
WinBioControlUnit.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    wintypes.DWORD,  # UnitId : DWORD
    wintypes.DWORD,  # Component : WINBIO_COMPONENT
    wintypes.DWORD,  # ControlCode : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # SendBuffer : BYTE*
    ctypes.c_size_t,  # SendBufferSize : UINT_PTR
    ctypes.POINTER(ctypes.c_ubyte),  # ReceiveBuffer : BYTE* out
    ctypes.c_size_t,  # ReceiveBufferSize : UINT_PTR
    ctypes.POINTER(ctypes.c_size_t),  # ReceiveDataSize : UINT_PTR* in/out
    ctypes.POINTER(wintypes.DWORD),  # OperationStatus : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioControlUnit = Fiddle::Function.new(
  lib['WinBioControlUnit'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    -Fiddle::TYPE_INT,  # UnitId : DWORD
    -Fiddle::TYPE_INT,  # Component : WINBIO_COMPONENT
    -Fiddle::TYPE_INT,  # ControlCode : DWORD
    Fiddle::TYPE_VOIDP,  # SendBuffer : BYTE*
    Fiddle::TYPE_UINTPTR_T,  # SendBufferSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # ReceiveBuffer : BYTE* out
    Fiddle::TYPE_UINTPTR_T,  # ReceiveBufferSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # ReceiveDataSize : UINT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # OperationStatus : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winbio")]
extern "system" {
    fn WinBioControlUnit(
        SessionHandle: u32,  // DWORD
        UnitId: u32,  // DWORD
        Component: u32,  // WINBIO_COMPONENT
        ControlCode: u32,  // DWORD
        SendBuffer: *mut u8,  // BYTE*
        SendBufferSize: usize,  // UINT_PTR
        ReceiveBuffer: *mut u8,  // BYTE* out
        ReceiveBufferSize: usize,  // UINT_PTR
        ReceiveDataSize: *mut usize,  // UINT_PTR* in/out
        OperationStatus: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioControlUnit(uint SessionHandle, uint UnitId, uint Component, uint ControlCode, IntPtr SendBuffer, UIntPtr SendBufferSize, IntPtr ReceiveBuffer, UIntPtr ReceiveBufferSize, ref UIntPtr ReceiveDataSize, IntPtr OperationStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioControlUnit' -Namespace Win32 -PassThru
# $api::WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, SendBuffer, SendBufferSize, ReceiveBuffer, ReceiveBufferSize, ReceiveDataSize, OperationStatus)

#uselib "winbio.dll"
#func global WinBioControlUnit "WinBioControlUnit" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinBioControlUnit SessionHandle, UnitId, Component, ControlCode, varptr(SendBuffer), SendBufferSize, varptr(ReceiveBuffer), ReceiveBufferSize, varptr(ReceiveDataSize), varptr(OperationStatus)   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; UnitId : DWORD -> "sptr"
; Component : WINBIO_COMPONENT -> "sptr"
; ControlCode : DWORD -> "sptr"
; SendBuffer : BYTE* -> "sptr"
; SendBufferSize : UINT_PTR -> "sptr"
; ReceiveBuffer : BYTE* out -> "sptr"
; ReceiveBufferSize : UINT_PTR -> "sptr"
; ReceiveDataSize : UINT_PTR* in/out -> "sptr"
; OperationStatus : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winbio.dll"
#cfunc global WinBioControlUnit "WinBioControlUnit" int, int, int, int, var, sptr, var, sptr, var, var
; res = WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, SendBuffer, SendBufferSize, ReceiveBuffer, ReceiveBufferSize, ReceiveDataSize, OperationStatus)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; Component : WINBIO_COMPONENT -> "int"
; ControlCode : DWORD -> "int"
; SendBuffer : BYTE* -> "var"
; SendBufferSize : UINT_PTR -> "sptr"
; ReceiveBuffer : BYTE* out -> "var"
; ReceiveBufferSize : UINT_PTR -> "sptr"
; ReceiveDataSize : UINT_PTR* in/out -> "var"
; OperationStatus : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll"
#cfunc global WinBioControlUnit "WinBioControlUnit" int, int, int, int, sptr, sptr, sptr, sptr, sptr, sptr
; res = WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, varptr(SendBuffer), SendBufferSize, varptr(ReceiveBuffer), ReceiveBufferSize, varptr(ReceiveDataSize), varptr(OperationStatus))
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; Component : WINBIO_COMPONENT -> "int"
; ControlCode : DWORD -> "int"
; SendBuffer : BYTE* -> "sptr"
; SendBufferSize : UINT_PTR -> "sptr"
; ReceiveBuffer : BYTE* out -> "sptr"
; ReceiveBufferSize : UINT_PTR -> "sptr"
; ReceiveDataSize : UINT_PTR* in/out -> "sptr"
; OperationStatus : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WinBioControlUnit(DWORD SessionHandle, DWORD UnitId, WINBIO_COMPONENT Component, DWORD ControlCode, BYTE* SendBuffer, UINT_PTR SendBufferSize, BYTE* ReceiveBuffer, UINT_PTR ReceiveBufferSize, UINT_PTR* ReceiveDataSize, DWORD* OperationStatus)
#uselib "winbio.dll"
#cfunc global WinBioControlUnit "WinBioControlUnit" int, int, int, int, var, intptr, var, intptr, var, var
; res = WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, SendBuffer, SendBufferSize, ReceiveBuffer, ReceiveBufferSize, ReceiveDataSize, OperationStatus)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; Component : WINBIO_COMPONENT -> "int"
; ControlCode : DWORD -> "int"
; SendBuffer : BYTE* -> "var"
; SendBufferSize : UINT_PTR -> "intptr"
; ReceiveBuffer : BYTE* out -> "var"
; ReceiveBufferSize : UINT_PTR -> "intptr"
; ReceiveDataSize : UINT_PTR* in/out -> "var"
; OperationStatus : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WinBioControlUnit(DWORD SessionHandle, DWORD UnitId, WINBIO_COMPONENT Component, DWORD ControlCode, BYTE* SendBuffer, UINT_PTR SendBufferSize, BYTE* ReceiveBuffer, UINT_PTR ReceiveBufferSize, UINT_PTR* ReceiveDataSize, DWORD* OperationStatus)
#uselib "winbio.dll"
#cfunc global WinBioControlUnit "WinBioControlUnit" int, int, int, int, intptr, intptr, intptr, intptr, intptr, intptr
; res = WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, varptr(SendBuffer), SendBufferSize, varptr(ReceiveBuffer), ReceiveBufferSize, varptr(ReceiveDataSize), varptr(OperationStatus))
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; Component : WINBIO_COMPONENT -> "int"
; ControlCode : DWORD -> "int"
; SendBuffer : BYTE* -> "intptr"
; SendBufferSize : UINT_PTR -> "intptr"
; ReceiveBuffer : BYTE* out -> "intptr"
; ReceiveBufferSize : UINT_PTR -> "intptr"
; ReceiveDataSize : UINT_PTR* in/out -> "intptr"
; OperationStatus : DWORD* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioControlUnit = winbio.NewProc("WinBioControlUnit")
)

// SessionHandle (DWORD), UnitId (DWORD), Component (WINBIO_COMPONENT), ControlCode (DWORD), SendBuffer (BYTE*), SendBufferSize (UINT_PTR), ReceiveBuffer (BYTE* out), ReceiveBufferSize (UINT_PTR), ReceiveDataSize (UINT_PTR* in/out), OperationStatus (DWORD* optional, out)
r1, _, err := procWinBioControlUnit.Call(
	uintptr(SessionHandle),
	uintptr(UnitId),
	uintptr(Component),
	uintptr(ControlCode),
	uintptr(SendBuffer),
	uintptr(SendBufferSize),
	uintptr(ReceiveBuffer),
	uintptr(ReceiveBufferSize),
	uintptr(ReceiveDataSize),
	uintptr(OperationStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WinBioControlUnit(
  SessionHandle: DWORD;   // DWORD
  UnitId: DWORD;   // DWORD
  Component: DWORD;   // WINBIO_COMPONENT
  ControlCode: DWORD;   // DWORD
  SendBuffer: Pointer;   // BYTE*
  SendBufferSize: NativeUInt;   // UINT_PTR
  ReceiveBuffer: Pointer;   // BYTE* out
  ReceiveBufferSize: NativeUInt;   // UINT_PTR
  ReceiveDataSize: Pointer;   // UINT_PTR* in/out
  OperationStatus: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioControlUnit';

result := DllCall("winbio\WinBioControlUnit"
    , "UInt", SessionHandle   ; DWORD
    , "UInt", UnitId   ; DWORD
    , "UInt", Component   ; WINBIO_COMPONENT
    , "UInt", ControlCode   ; DWORD
    , "Ptr", SendBuffer   ; BYTE*
    , "UPtr", SendBufferSize   ; UINT_PTR
    , "Ptr", ReceiveBuffer   ; BYTE* out
    , "UPtr", ReceiveBufferSize   ; UINT_PTR
    , "Ptr", ReceiveDataSize   ; UINT_PTR* in/out
    , "Ptr", OperationStatus   ; DWORD* optional, out
    , "Int")   ; return: HRESULT

●WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, SendBuffer, SendBufferSize, ReceiveBuffer, ReceiveBufferSize, ReceiveDataSize, OperationStatus) = DLL("winbio.dll", "int WinBioControlUnit(dword, dword, dword, dword, void*, int, void*, int, void*, void*)")
# 呼び出し: WinBioControlUnit(SessionHandle, UnitId, Component, ControlCode, SendBuffer, SendBufferSize, ReceiveBuffer, ReceiveBufferSize, ReceiveDataSize, OperationStatus)
# SessionHandle : DWORD -> "dword"
# UnitId : DWORD -> "dword"
# Component : WINBIO_COMPONENT -> "dword"
# ControlCode : DWORD -> "dword"
# SendBuffer : BYTE* -> "void*"
# SendBufferSize : UINT_PTR -> "int"
# ReceiveBuffer : BYTE* out -> "void*"
# ReceiveBufferSize : UINT_PTR -> "int"
# ReceiveDataSize : UINT_PTR* in/out -> "void*"
# OperationStatus : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。