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

WinBioIdentify

関数
採取した生体情報から該当する利用者IDを特定する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WinBioIdentify(
    DWORD SessionHandle,
    DWORD* UnitId,   // optional
    WINBIO_IDENTITY* Identity,   // optional
    BYTE* SubFactor,   // optional
    DWORD* RejectDetail   // optional
);

パラメーター

名前型方向説明
SessionHandleDWORDin識別に用いるセッションのハンドル。
UnitIdDWORD*outoptional識別を行ったユニットのIDを受け取る出力ポインタ。
IdentityWINBIO_IDENTITY*outoptional識別されたユーザーのIDを受け取る出力構造体ポインタ。
SubFactorBYTE*outoptional識別された下位ファクターを受け取るバイト出力ポインタ。
RejectDetailDWORD*outoptionalキャプチャ失敗時の詳細理由コードを受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WinBioIdentify(
    DWORD SessionHandle,
    DWORD* UnitId,   // optional
    WINBIO_IDENTITY* Identity,   // optional
    BYTE* SubFactor,   // optional
    DWORD* RejectDetail   // optional
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioIdentify(
    uint SessionHandle,   // DWORD
    IntPtr UnitId,   // DWORD* optional, out
    IntPtr Identity,   // WINBIO_IDENTITY* optional, out
    IntPtr SubFactor,   // BYTE* optional, out
    IntPtr RejectDetail   // DWORD* optional, out
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioIdentify(
    SessionHandle As UInteger,   ' DWORD
    UnitId As IntPtr,   ' DWORD* optional, out
    Identity As IntPtr,   ' WINBIO_IDENTITY* optional, out
    SubFactor As IntPtr,   ' BYTE* optional, out
    RejectDetail As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' SessionHandle : DWORD
' UnitId : DWORD* optional, out
' Identity : WINBIO_IDENTITY* optional, out
' SubFactor : BYTE* optional, out
' RejectDetail : DWORD* optional, out
Declare PtrSafe Function WinBioIdentify Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal UnitId As LongPtr, _
    ByVal Identity As LongPtr, _
    ByVal SubFactor 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

WinBioIdentify = ctypes.windll.winbio.WinBioIdentify
WinBioIdentify.restype = ctypes.c_int
WinBioIdentify.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.POINTER(wintypes.DWORD),  # UnitId : DWORD* optional, out
    ctypes.c_void_p,  # Identity : WINBIO_IDENTITY* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # SubFactor : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # RejectDetail : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioIdentify = Fiddle::Function.new(
  lib['WinBioIdentify'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    Fiddle::TYPE_VOIDP,  # UnitId : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Identity : WINBIO_IDENTITY* optional, out
    Fiddle::TYPE_VOIDP,  # SubFactor : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # RejectDetail : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winbio")]
extern "system" {
    fn WinBioIdentify(
        SessionHandle: u32,  // DWORD
        UnitId: *mut u32,  // DWORD* optional, out
        Identity: *mut WINBIO_IDENTITY,  // WINBIO_IDENTITY* optional, out
        SubFactor: *mut u8,  // BYTE* 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 WinBioIdentify(uint SessionHandle, IntPtr UnitId, IntPtr Identity, IntPtr SubFactor, IntPtr RejectDetail);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioIdentify' -Namespace Win32 -PassThru
# $api::WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
#uselib "winbio.dll"
#func global WinBioIdentify "WinBioIdentify" sptr, sptr, sptr, sptr, sptr
; WinBioIdentify SessionHandle, varptr(UnitId), varptr(Identity), varptr(SubFactor), varptr(RejectDetail)   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; UnitId : DWORD* optional, out -> "sptr"
; Identity : WINBIO_IDENTITY* optional, out -> "sptr"
; SubFactor : BYTE* optional, out -> "sptr"
; RejectDetail : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "winbio.dll"
#cfunc global WinBioIdentify "WinBioIdentify" int, var, var, var, var
; res = WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD* optional, out -> "var"
; Identity : WINBIO_IDENTITY* optional, out -> "var"
; SubFactor : BYTE* optional, out -> "var"
; RejectDetail : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT WinBioIdentify(DWORD SessionHandle, DWORD* UnitId, WINBIO_IDENTITY* Identity, BYTE* SubFactor, DWORD* RejectDetail)
#uselib "winbio.dll"
#cfunc global WinBioIdentify "WinBioIdentify" int, var, var, var, var
; res = WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD* optional, out -> "var"
; Identity : WINBIO_IDENTITY* optional, out -> "var"
; SubFactor : BYTE* optional, out -> "var"
; RejectDetail : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioIdentify = winbio.NewProc("WinBioIdentify")
)

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

extern "winbio" fn WinBioIdentify(
    SessionHandle: u32, // DWORD
    UnitId: [*c]u32, // DWORD* optional, out
    Identity: [*c]WINBIO_IDENTITY, // WINBIO_IDENTITY* optional, out
    SubFactor: [*c]u8, // BYTE* optional, out
    RejectDetail: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc WinBioIdentify(
    SessionHandle: uint32,  # DWORD
    UnitId: ptr uint32,  # DWORD* optional, out
    Identity: ptr WINBIO_IDENTITY,  # WINBIO_IDENTITY* optional, out
    SubFactor: ptr uint8,  # BYTE* optional, out
    RejectDetail: ptr uint32  # DWORD* optional, out
): int32 {.importc: "WinBioIdentify", stdcall, dynlib: "winbio.dll".}
pragma(lib, "winbio");
extern(Windows)
int WinBioIdentify(
    uint SessionHandle,   // DWORD
    uint* UnitId,   // DWORD* optional, out
    WINBIO_IDENTITY* Identity,   // WINBIO_IDENTITY* optional, out
    ubyte* SubFactor,   // BYTE* optional, out
    uint* RejectDetail   // DWORD* optional, out
);
ccall((:WinBioIdentify, "winbio.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt32}, Ptr{WINBIO_IDENTITY}, Ptr{UInt8}, Ptr{UInt32}),
      SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
# SessionHandle : DWORD -> UInt32
# UnitId : DWORD* optional, out -> Ptr{UInt32}
# Identity : WINBIO_IDENTITY* optional, out -> Ptr{WINBIO_IDENTITY}
# SubFactor : BYTE* optional, out -> Ptr{UInt8}
# RejectDetail : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioIdentify(
    uint32_t SessionHandle,
    uint32_t* UnitId,
    void* Identity,
    uint8_t* SubFactor,
    uint32_t* RejectDetail);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
-- SessionHandle : DWORD
-- UnitId : DWORD* optional, out
-- Identity : WINBIO_IDENTITY* optional, out
-- SubFactor : BYTE* optional, out
-- RejectDetail : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioIdentify = lib.func('__stdcall', 'WinBioIdentify', 'int32_t', ['uint32_t', 'uint32_t *', 'void *', 'uint8_t *', 'uint32_t *']);
// WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
// SessionHandle : DWORD -> 'uint32_t'
// UnitId : DWORD* optional, out -> 'uint32_t *'
// Identity : WINBIO_IDENTITY* optional, out -> 'void *'
// SubFactor : BYTE* optional, out -> 'uint8_t *'
// RejectDetail : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winbio.dll", {
  WinBioIdentify: { parameters: ["u32", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail)
// SessionHandle : DWORD -> "u32"
// UnitId : DWORD* optional, out -> "pointer"
// Identity : WINBIO_IDENTITY* optional, out -> "pointer"
// SubFactor : BYTE* optional, out -> "pointer"
// RejectDetail : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioIdentify(
    uint32_t SessionHandle,
    uint32_t* UnitId,
    void* Identity,
    uint8_t* SubFactor,
    uint32_t* RejectDetail);
C, "winbio.dll");
// $ffi->WinBioIdentify(SessionHandle, UnitId, Identity, SubFactor, RejectDetail);
// SessionHandle : DWORD
// UnitId : DWORD* optional, out
// Identity : WINBIO_IDENTITY* optional, out
// SubFactor : BYTE* 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 WinBioIdentify(
        int SessionHandle,   // DWORD
        IntByReference UnitId,   // DWORD* optional, out
        Pointer Identity,   // WINBIO_IDENTITY* optional, out
        byte[] SubFactor,   // BYTE* optional, out
        IntByReference RejectDetail   // DWORD* optional, out
    );
}
@[Link("winbio")]
lib Libwinbio
  fun WinBioIdentify = WinBioIdentify(
    SessionHandle : UInt32,   # DWORD
    UnitId : UInt32*,   # DWORD* optional, out
    Identity : WINBIO_IDENTITY*,   # WINBIO_IDENTITY* optional, out
    SubFactor : UInt8*,   # BYTE* 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 WinBioIdentifyNative = Int32 Function(Uint32, Pointer<Uint32>, Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
typedef WinBioIdentifyDart = int Function(int, Pointer<Uint32>, Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
final WinBioIdentify = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioIdentifyNative, WinBioIdentifyDart>('WinBioIdentify');
// SessionHandle : DWORD -> Uint32
// UnitId : DWORD* optional, out -> Pointer<Uint32>
// Identity : WINBIO_IDENTITY* optional, out -> Pointer<Void>
// SubFactor : BYTE* optional, out -> Pointer<Uint8>
// RejectDetail : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioIdentify(
  SessionHandle: DWORD;   // DWORD
  UnitId: Pointer;   // DWORD* optional, out
  Identity: Pointer;   // WINBIO_IDENTITY* optional, out
  SubFactor: Pointer;   // BYTE* optional, out
  RejectDetail: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioIdentify';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioIdentify"
  c_WinBioIdentify :: Word32 -> Ptr Word32 -> Ptr () -> Ptr Word8 -> Ptr Word32 -> IO Int32
-- SessionHandle : DWORD -> Word32
-- UnitId : DWORD* optional, out -> Ptr Word32
-- Identity : WINBIO_IDENTITY* optional, out -> Ptr ()
-- SubFactor : BYTE* optional, out -> Ptr Word8
-- RejectDetail : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbioidentify =
  foreign "WinBioIdentify"
    (uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* UnitId : DWORD* optional, out -> (ptr uint32_t) *)
(* Identity : WINBIO_IDENTITY* optional, out -> (ptr void) *)
(* SubFactor : BYTE* optional, out -> (ptr uint8_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 ("WinBioIdentify" win-bio-identify :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (unit-id :pointer)   ; DWORD* optional, out
  (identity :pointer)   ; WINBIO_IDENTITY* optional, out
  (sub-factor :pointer)   ; BYTE* optional, out
  (reject-detail :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioIdentify = Win32::API::More->new('winbio',
    'int WinBioIdentify(DWORD SessionHandle, LPVOID UnitId, LPVOID Identity, LPVOID SubFactor, LPVOID RejectDetail)');
# my $ret = $WinBioIdentify->Call($SessionHandle, $UnitId, $Identity, $SubFactor, $RejectDetail);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD* optional, out -> LPVOID
# Identity : WINBIO_IDENTITY* optional, out -> LPVOID
# SubFactor : BYTE* optional, out -> LPVOID
# RejectDetail : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型