ホーム › Devices.BiometricFramework › WinBioCaptureSample

WinBioCaptureSample

関数

指定用途で生体サンプルを採取して取得する。

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

シグネチャ

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

HRESULT WinBioCaptureSample(
    DWORD SessionHandle,
    BYTE Purpose,
    BYTE Flags,
    DWORD* UnitId,   // optional
    WINBIO_BIR** Sample,
    UINT_PTR* SampleSize,   // optional
    DWORD* RejectDetail   // optional
);

パラメーター

名前	型	方向
SessionHandle	DWORD	in
Purpose	BYTE	in
Flags	BYTE	in
UnitId	DWORD*	outoptional
Sample	WINBIO_BIR**	out
SampleSize	UINT_PTR*	outoptional
RejectDetail	DWORD*	outoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WinBioCaptureSample(
    DWORD SessionHandle,
    BYTE Purpose,
    BYTE Flags,
    DWORD* UnitId,   // optional
    WINBIO_BIR** Sample,
    UINT_PTR* SampleSize,   // optional
    DWORD* RejectDetail   // optional
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioCaptureSample(
    uint SessionHandle,   // DWORD
    byte Purpose,   // BYTE
    byte Flags,   // BYTE
    IntPtr UnitId,   // DWORD* optional, out
    IntPtr Sample,   // WINBIO_BIR** out
    IntPtr SampleSize,   // UINT_PTR* optional, out
    IntPtr RejectDetail   // DWORD* optional, out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioCaptureSample(
    SessionHandle As UInteger,   ' DWORD
    Purpose As Byte,   ' BYTE
    Flags As Byte,   ' BYTE
    UnitId As IntPtr,   ' DWORD* optional, out
    Sample As IntPtr,   ' WINBIO_BIR** out
    SampleSize As IntPtr,   ' UINT_PTR* optional, out
    RejectDetail As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' SessionHandle : DWORD
' Purpose : BYTE
' Flags : BYTE
' UnitId : DWORD* optional, out
' Sample : WINBIO_BIR** out
' SampleSize : UINT_PTR* optional, out
' RejectDetail : DWORD* optional, out
Declare PtrSafe Function WinBioCaptureSample Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal Purpose As Byte, _
    ByVal Flags As Byte, _
    ByVal UnitId As LongPtr, _
    ByVal Sample As LongPtr, _
    ByVal SampleSize As LongPtr, _
    ByVal RejectDetail As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinBioCaptureSample = ctypes.windll.winbio.WinBioCaptureSample
WinBioCaptureSample.restype = ctypes.c_int
WinBioCaptureSample.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.c_ubyte,  # Purpose : BYTE
    ctypes.c_ubyte,  # Flags : BYTE
    ctypes.POINTER(wintypes.DWORD),  # UnitId : DWORD* optional, out
    ctypes.c_void_p,  # Sample : WINBIO_BIR** out
    ctypes.POINTER(ctypes.c_size_t),  # SampleSize : UINT_PTR* optional, out
    ctypes.POINTER(wintypes.DWORD),  # RejectDetail : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioCaptureSample = Fiddle::Function.new(
  lib['WinBioCaptureSample'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    -Fiddle::TYPE_CHAR,  # Purpose : BYTE
    -Fiddle::TYPE_CHAR,  # Flags : BYTE
    Fiddle::TYPE_VOIDP,  # UnitId : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Sample : WINBIO_BIR** out
    Fiddle::TYPE_VOIDP,  # SampleSize : UINT_PTR* optional, out
    Fiddle::TYPE_VOIDP,  # RejectDetail : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winbio")]
extern "system" {
    fn WinBioCaptureSample(
        SessionHandle: u32,  // DWORD
        Purpose: u8,  // BYTE
        Flags: u8,  // BYTE
        UnitId: *mut u32,  // DWORD* optional, out
        Sample: *mut *mut WINBIO_BIR,  // WINBIO_BIR** out
        SampleSize: *mut usize,  // UINT_PTR* optional, out
        RejectDetail: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioCaptureSample(uint SessionHandle, byte Purpose, byte Flags, IntPtr UnitId, IntPtr Sample, IntPtr SampleSize, IntPtr RejectDetail);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioCaptureSample' -Namespace Win32 -PassThru
# $api::WinBioCaptureSample(SessionHandle, Purpose, Flags, UnitId, Sample, SampleSize, RejectDetail)

#uselib "winbio.dll"
#func global WinBioCaptureSample "WinBioCaptureSample" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinBioCaptureSample SessionHandle, Purpose, Flags, varptr(UnitId), varptr(Sample), varptr(SampleSize), varptr(RejectDetail)   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; Purpose : BYTE -> "sptr"
; Flags : BYTE -> "sptr"
; UnitId : DWORD* optional, out -> "sptr"
; Sample : WINBIO_BIR** out -> "sptr"
; SampleSize : UINT_PTR* optional, out -> "sptr"
; RejectDetail : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winbio.dll"
#cfunc global WinBioCaptureSample "WinBioCaptureSample" int, int, int, var, var, var, var
; res = WinBioCaptureSample(SessionHandle, Purpose, Flags, UnitId, Sample, SampleSize, RejectDetail)
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; UnitId : DWORD* optional, out -> "var"
; Sample : WINBIO_BIR** out -> "var"
; SampleSize : UINT_PTR* optional, out -> "var"
; RejectDetail : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll"
#cfunc global WinBioCaptureSample "WinBioCaptureSample" int, int, int, sptr, sptr, sptr, sptr
; res = WinBioCaptureSample(SessionHandle, Purpose, Flags, varptr(UnitId), varptr(Sample), varptr(SampleSize), varptr(RejectDetail))
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; UnitId : DWORD* optional, out -> "sptr"
; Sample : WINBIO_BIR** out -> "sptr"
; SampleSize : UINT_PTR* optional, out -> "sptr"
; RejectDetail : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WinBioCaptureSample(DWORD SessionHandle, BYTE Purpose, BYTE Flags, DWORD* UnitId, WINBIO_BIR** Sample, UINT_PTR* SampleSize, DWORD* RejectDetail)
#uselib "winbio.dll"
#cfunc global WinBioCaptureSample "WinBioCaptureSample" int, int, int, var, var, var, var
; res = WinBioCaptureSample(SessionHandle, Purpose, Flags, UnitId, Sample, SampleSize, RejectDetail)
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; UnitId : DWORD* optional, out -> "var"
; Sample : WINBIO_BIR** out -> "var"
; SampleSize : UINT_PTR* optional, out -> "var"
; RejectDetail : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WinBioCaptureSample(DWORD SessionHandle, BYTE Purpose, BYTE Flags, DWORD* UnitId, WINBIO_BIR** Sample, UINT_PTR* SampleSize, DWORD* RejectDetail)
#uselib "winbio.dll"
#cfunc global WinBioCaptureSample "WinBioCaptureSample" int, int, int, intptr, intptr, intptr, intptr
; res = WinBioCaptureSample(SessionHandle, Purpose, Flags, varptr(UnitId), varptr(Sample), varptr(SampleSize), varptr(RejectDetail))
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; UnitId : DWORD* optional, out -> "intptr"
; Sample : WINBIO_BIR** out -> "intptr"
; SampleSize : UINT_PTR* optional, out -> "intptr"
; RejectDetail : DWORD* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioCaptureSample = winbio.NewProc("WinBioCaptureSample")
)

// SessionHandle (DWORD), Purpose (BYTE), Flags (BYTE), UnitId (DWORD* optional, out), Sample (WINBIO_BIR** out), SampleSize (UINT_PTR* optional, out), RejectDetail (DWORD* optional, out)
r1, _, err := procWinBioCaptureSample.Call(
	uintptr(SessionHandle),
	uintptr(Purpose),
	uintptr(Flags),
	uintptr(UnitId),
	uintptr(Sample),
	uintptr(SampleSize),
	uintptr(RejectDetail),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WinBioCaptureSample(
  SessionHandle: DWORD;   // DWORD
  Purpose: Byte;   // BYTE
  Flags: Byte;   // BYTE
  UnitId: Pointer;   // DWORD* optional, out
  Sample: Pointer;   // WINBIO_BIR** out
  SampleSize: Pointer;   // UINT_PTR* optional, out
  RejectDetail: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioCaptureSample';

result := DllCall("winbio\WinBioCaptureSample"
    , "UInt", SessionHandle   ; DWORD
    , "UChar", Purpose   ; BYTE
    , "UChar", Flags   ; BYTE
    , "Ptr", UnitId   ; DWORD* optional, out
    , "Ptr", Sample   ; WINBIO_BIR** out
    , "Ptr", SampleSize   ; UINT_PTR* optional, out
    , "Ptr", RejectDetail   ; DWORD* optional, out
    , "Int")   ; return: HRESULT

●WinBioCaptureSample(SessionHandle, Purpose, Flags, UnitId, Sample, SampleSize, RejectDetail) = DLL("winbio.dll", "int WinBioCaptureSample(dword, byte, byte, void*, void*, void*, void*)")
# 呼び出し: WinBioCaptureSample(SessionHandle, Purpose, Flags, UnitId, Sample, SampleSize, RejectDetail)
# SessionHandle : DWORD -> "dword"
# Purpose : BYTE -> "byte"
# Flags : BYTE -> "byte"
# UnitId : DWORD* optional, out -> "void*"
# Sample : WINBIO_BIR** out -> "void*"
# SampleSize : UINT_PTR* optional, out -> "void*"
# RejectDetail : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。