Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
SessionHandleDWORDinサンプルキャプチャに用いるセッションのハンドル。
PurposeBYTEinキャプチャ用途(検証/識別/登録等)を示すバイトフラグ。WINBIO_PURPOSE値。
FlagsBYTEinサンプル形式を指定するバイトフラグ。WINBIO_DATA_FLAG_RAW等。
UnitIdDWORD*outoptionalキャプチャを行ったユニットのIDを受け取る出力ポインタ。
SampleWINBIO_BIR**out取得した生体サンプル(BIR)を受け取る出力ポインタ。要WinBioFreeで解放。
SampleSizeUINT_PTR*outoptional取得サンプルのバイトサイズを受け取る出力ポインタ。
RejectDetailDWORD*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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。
const std = @import("std");

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

typedef WinBioCaptureSampleNative = Int32 Function(Uint32, Uint8, Uint8, Pointer<Uint32>, Pointer<Void>, Pointer<UintPtr>, Pointer<Uint32>);
typedef WinBioCaptureSampleDart = int Function(int, int, int, Pointer<Uint32>, Pointer<Void>, Pointer<UintPtr>, Pointer<Uint32>);
final WinBioCaptureSample = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioCaptureSampleNative, WinBioCaptureSampleDart>('WinBioCaptureSample');
// SessionHandle : DWORD -> Uint32
// Purpose : BYTE -> Uint8
// Flags : BYTE -> Uint8
// UnitId : DWORD* optional, out -> Pointer<Uint32>
// Sample : WINBIO_BIR** out -> Pointer<Void>
// SampleSize : UINT_PTR* optional, out -> Pointer<UintPtr>
// RejectDetail : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioCaptureSample"
  c_WinBioCaptureSample :: Word32 -> Word8 -> Word8 -> Ptr Word32 -> Ptr () -> Ptr CUIntPtr -> Ptr Word32 -> IO Int32
-- SessionHandle : DWORD -> Word32
-- Purpose : BYTE -> Word8
-- Flags : BYTE -> Word8
-- UnitId : DWORD* optional, out -> Ptr Word32
-- Sample : WINBIO_BIR** out -> Ptr ()
-- SampleSize : UINT_PTR* optional, out -> Ptr CUIntPtr
-- RejectDetail : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbiocapturesample =
  foreign "WinBioCaptureSample"
    (uint32_t @-> uint8_t @-> uint8_t @-> (ptr uint32_t) @-> (ptr void) @-> (ptr size_t) @-> (ptr uint32_t) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* Purpose : BYTE -> uint8_t *)
(* Flags : BYTE -> uint8_t *)
(* UnitId : DWORD* optional, out -> (ptr uint32_t) *)
(* Sample : WINBIO_BIR** out -> (ptr void) *)
(* SampleSize : UINT_PTR* optional, out -> (ptr size_t) *)
(* RejectDetail : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioCaptureSample" win-bio-capture-sample :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (purpose :uint8)   ; BYTE
  (flags :uint8)   ; BYTE
  (unit-id :pointer)   ; DWORD* optional, out
  (sample :pointer)   ; WINBIO_BIR** out
  (sample-size :pointer)   ; UINT_PTR* optional, out
  (reject-detail :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioCaptureSample = Win32::API::More->new('winbio',
    'int WinBioCaptureSample(DWORD SessionHandle, BYTE Purpose, BYTE Flags, LPVOID UnitId, LPVOID Sample, LPVOID SampleSize, LPVOID RejectDetail)');
# my $ret = $WinBioCaptureSample->Call($SessionHandle, $Purpose, $Flags, $UnitId, $Sample, $SampleSize, $RejectDetail);
# SessionHandle : DWORD -> DWORD
# Purpose : BYTE -> BYTE
# Flags : BYTE -> BYTE
# UnitId : DWORD* optional, out -> LPVOID
# Sample : WINBIO_BIR** out -> LPVOID
# SampleSize : UINT_PTR* optional, out -> LPVOID
# RejectDetail : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型