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

WinBioCaptureSampleWithCallback

関数
コールバック方式で生体サンプルを採取する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioCaptureSampleWithCallback(
    DWORD SessionHandle,
    BYTE Purpose,
    BYTE Flags,
    PWINBIO_CAPTURE_CALLBACK CaptureCallback,
    void* CaptureCallbackContext   // optional
);

パラメーター

名前方向説明
SessionHandleDWORDinサンプルキャプチャに用いるセッションのハンドル。
PurposeBYTEinキャプチャ用途(検証/識別/登録等)を示すバイトフラグ。WINBIO_PURPOSE値。
FlagsBYTEinサンプル形式を指定するバイトフラグ。WINBIO_DATA_FLAG_RAW等。
CaptureCallbackPWINBIO_CAPTURE_CALLBACKinキャプチャ完了時に呼ばれるコールバック関数へのポインタ。
CaptureCallbackContextvoid*inoptionalコールバックに渡される任意のコンテキストポインタ。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WinBioCaptureSampleWithCallback(
    DWORD SessionHandle,
    BYTE Purpose,
    BYTE Flags,
    PWINBIO_CAPTURE_CALLBACK CaptureCallback,
    void* CaptureCallbackContext   // optional
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioCaptureSampleWithCallback(
    uint SessionHandle,   // DWORD
    byte Purpose,   // BYTE
    byte Flags,   // BYTE
    IntPtr CaptureCallback,   // PWINBIO_CAPTURE_CALLBACK
    IntPtr CaptureCallbackContext   // void* optional
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioCaptureSampleWithCallback(
    SessionHandle As UInteger,   ' DWORD
    Purpose As Byte,   ' BYTE
    Flags As Byte,   ' BYTE
    CaptureCallback As IntPtr,   ' PWINBIO_CAPTURE_CALLBACK
    CaptureCallbackContext As IntPtr   ' void* optional
) As Integer
End Function
' SessionHandle : DWORD
' Purpose : BYTE
' Flags : BYTE
' CaptureCallback : PWINBIO_CAPTURE_CALLBACK
' CaptureCallbackContext : void* optional
Declare PtrSafe Function WinBioCaptureSampleWithCallback Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal Purpose As Byte, _
    ByVal Flags As Byte, _
    ByVal CaptureCallback As LongPtr, _
    ByVal CaptureCallbackContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinBioCaptureSampleWithCallback = ctypes.windll.winbio.WinBioCaptureSampleWithCallback
WinBioCaptureSampleWithCallback.restype = ctypes.c_int
WinBioCaptureSampleWithCallback.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.c_ubyte,  # Purpose : BYTE
    ctypes.c_ubyte,  # Flags : BYTE
    ctypes.c_void_p,  # CaptureCallback : PWINBIO_CAPTURE_CALLBACK
    ctypes.POINTER(None),  # CaptureCallbackContext : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioCaptureSampleWithCallback = Fiddle::Function.new(
  lib['WinBioCaptureSampleWithCallback'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    -Fiddle::TYPE_CHAR,  # Purpose : BYTE
    -Fiddle::TYPE_CHAR,  # Flags : BYTE
    Fiddle::TYPE_VOIDP,  # CaptureCallback : PWINBIO_CAPTURE_CALLBACK
    Fiddle::TYPE_VOIDP,  # CaptureCallbackContext : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "winbio")]
extern "system" {
    fn WinBioCaptureSampleWithCallback(
        SessionHandle: u32,  // DWORD
        Purpose: u8,  // BYTE
        Flags: u8,  // BYTE
        CaptureCallback: *const core::ffi::c_void,  // PWINBIO_CAPTURE_CALLBACK
        CaptureCallbackContext: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioCaptureSampleWithCallback(uint SessionHandle, byte Purpose, byte Flags, IntPtr CaptureCallback, IntPtr CaptureCallbackContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioCaptureSampleWithCallback' -Namespace Win32 -PassThru
# $api::WinBioCaptureSampleWithCallback(SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext)
#uselib "winbio.dll"
#func global WinBioCaptureSampleWithCallback "WinBioCaptureSampleWithCallback" sptr, sptr, sptr, sptr, sptr
; WinBioCaptureSampleWithCallback SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; Purpose : BYTE -> "sptr"
; Flags : BYTE -> "sptr"
; CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> "sptr"
; CaptureCallbackContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winbio.dll"
#cfunc global WinBioCaptureSampleWithCallback "WinBioCaptureSampleWithCallback" int, int, int, sptr, sptr
; res = WinBioCaptureSampleWithCallback(SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext)
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> "sptr"
; CaptureCallbackContext : void* optional -> "sptr"
; HRESULT WinBioCaptureSampleWithCallback(DWORD SessionHandle, BYTE Purpose, BYTE Flags, PWINBIO_CAPTURE_CALLBACK CaptureCallback, void* CaptureCallbackContext)
#uselib "winbio.dll"
#cfunc global WinBioCaptureSampleWithCallback "WinBioCaptureSampleWithCallback" int, int, int, intptr, intptr
; res = WinBioCaptureSampleWithCallback(SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext)
; SessionHandle : DWORD -> "int"
; Purpose : BYTE -> "int"
; Flags : BYTE -> "int"
; CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> "intptr"
; CaptureCallbackContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioCaptureSampleWithCallback = winbio.NewProc("WinBioCaptureSampleWithCallback")
)

// SessionHandle (DWORD), Purpose (BYTE), Flags (BYTE), CaptureCallback (PWINBIO_CAPTURE_CALLBACK), CaptureCallbackContext (void* optional)
r1, _, err := procWinBioCaptureSampleWithCallback.Call(
	uintptr(SessionHandle),
	uintptr(Purpose),
	uintptr(Flags),
	uintptr(CaptureCallback),
	uintptr(CaptureCallbackContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WinBioCaptureSampleWithCallback(
  SessionHandle: DWORD;   // DWORD
  Purpose: Byte;   // BYTE
  Flags: Byte;   // BYTE
  CaptureCallback: Pointer;   // PWINBIO_CAPTURE_CALLBACK
  CaptureCallbackContext: Pointer   // void* optional
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioCaptureSampleWithCallback';
result := DllCall("winbio\WinBioCaptureSampleWithCallback"
    , "UInt", SessionHandle   ; DWORD
    , "UChar", Purpose   ; BYTE
    , "UChar", Flags   ; BYTE
    , "Ptr", CaptureCallback   ; PWINBIO_CAPTURE_CALLBACK
    , "Ptr", CaptureCallbackContext   ; void* optional
    , "Int")   ; return: HRESULT
●WinBioCaptureSampleWithCallback(SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext) = DLL("winbio.dll", "int WinBioCaptureSampleWithCallback(dword, byte, byte, void*, void*)")
# 呼び出し: WinBioCaptureSampleWithCallback(SessionHandle, Purpose, Flags, CaptureCallback, CaptureCallbackContext)
# SessionHandle : DWORD -> "dword"
# Purpose : BYTE -> "byte"
# Flags : BYTE -> "byte"
# CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> "void*"
# CaptureCallbackContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WinBioCaptureSampleWithCallbackNative = Int32 Function(Uint32, Uint8, Uint8, Pointer<Void>, Pointer<Void>);
typedef WinBioCaptureSampleWithCallbackDart = int Function(int, int, int, Pointer<Void>, Pointer<Void>);
final WinBioCaptureSampleWithCallback = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioCaptureSampleWithCallbackNative, WinBioCaptureSampleWithCallbackDart>('WinBioCaptureSampleWithCallback');
// SessionHandle : DWORD -> Uint32
// Purpose : BYTE -> Uint8
// Flags : BYTE -> Uint8
// CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> Pointer<Void>
// CaptureCallbackContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioCaptureSampleWithCallback(
  SessionHandle: DWORD;   // DWORD
  Purpose: Byte;   // BYTE
  Flags: Byte;   // BYTE
  CaptureCallback: Pointer;   // PWINBIO_CAPTURE_CALLBACK
  CaptureCallbackContext: Pointer   // void* optional
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioCaptureSampleWithCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioCaptureSampleWithCallback"
  c_WinBioCaptureSampleWithCallback :: Word32 -> Word8 -> Word8 -> Ptr () -> Ptr () -> IO Int32
-- SessionHandle : DWORD -> Word32
-- Purpose : BYTE -> Word8
-- Flags : BYTE -> Word8
-- CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> Ptr ()
-- CaptureCallbackContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbiocapturesamplewithcallback =
  foreign "WinBioCaptureSampleWithCallback"
    (uint32_t @-> uint8_t @-> uint8_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* Purpose : BYTE -> uint8_t *)
(* Flags : BYTE -> uint8_t *)
(* CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> (ptr void) *)
(* CaptureCallbackContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioCaptureSampleWithCallback" win-bio-capture-sample-with-callback :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (purpose :uint8)   ; BYTE
  (flags :uint8)   ; BYTE
  (capture-callback :pointer)   ; PWINBIO_CAPTURE_CALLBACK
  (capture-callback-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioCaptureSampleWithCallback = Win32::API::More->new('winbio',
    'int WinBioCaptureSampleWithCallback(DWORD SessionHandle, BYTE Purpose, BYTE Flags, LPVOID CaptureCallback, LPVOID CaptureCallbackContext)');
# my $ret = $WinBioCaptureSampleWithCallback->Call($SessionHandle, $Purpose, $Flags, $CaptureCallback, $CaptureCallbackContext);
# SessionHandle : DWORD -> DWORD
# Purpose : BYTE -> BYTE
# Flags : BYTE -> BYTE
# CaptureCallback : PWINBIO_CAPTURE_CALLBACK -> LPVOID
# CaptureCallbackContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型