WinBioEnumEnrollments
関数シグネチャ
// winbio.dll
#include <windows.h>
HRESULT WinBioEnumEnrollments(
DWORD SessionHandle,
DWORD UnitId,
WINBIO_IDENTITY* Identity,
BYTE** SubFactorArray,
UINT_PTR* SubFactorCount // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| SessionHandle | DWORD | in | 開いている生体認証セッションを識別する WINBIO_SESSION_HANDLE 値です。同期セッション ハンドルは WinBioOpenSession を呼び出して開きます。非同期セッション ハンドルは WinBioAsyncOpenSession を呼び出して開きます。 |
| UnitId | DWORD | in | 生体認証ユニットを指定する WINBIO_UNIT_ID 値です。 |
| Identity | WINBIO_IDENTITY* | in | サブファクターの取得元となるテンプレートの GUID または SID を格納した WINBIO_IDENTITY 構造体へのポインターです。 |
| SubFactorArray | BYTE** | out | サブファクターの配列へのポインターを受け取る変数のアドレスです。関数が成功しなかった場合、このポインターには NULL が設定されます。関数が成功した場合は、配列用に内部で割り当てられたメモリを解放するために、このポインターを WinBioFree に渡す必要があります。 |
| SubFactorCount | UINT_PTR* | outoptional | SubFactorArray パラメーターが指す配列の要素数を格納する値へのポインターです。関数が成功しなかった場合、この値は 0 に設定されます。 |
戻り値の型: HRESULT
公式ドキュメント
指定した ID と生体認証ユニットに対して登録されている生体サブファクターを取得します。Windows 10 ビルド 1607 以降、この関数はモバイル イメージで使用できます。
戻り値
関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示す HRESULT 値を返します。返される可能性のある値には次の表のものが含まれますが、これらに限定されません。一般的なエラー コードの一覧については、「Common HRESULT Values」を参照してください。
| 戻り値 | 説明 |
|---|---|
| セッション ハンドルが有効ではありません。 | |
| UnitId パラメーターに 0 を指定することはできません。 | |
| Identity、SubFactorArray、SubFactorCount の各パラメーターに NULL を指定することはできません。 | |
| UnitId パラメーターで指定された生体認証ユニットが現在登録トランザクションで使用されているため、操作を完了できませんでした。 | |
| Identity パラメーターで指定された GUID または SID が見つかりません。 |
解説(Remarks)
WinBioEnumEnrollments 関数は、主にアプリケーションがユーザーにフィードバックを提供できるようにするために用意されています。たとえば、特定の指紋リーダーに既に登録されている指紋をユーザーに知らせるために、アプリケーションからこの関数を呼び出すことができます。
SubFactorArray パラメーターに返された構造体の使用を終えたら、配列用に内部で割り当てられたメモリを解放するために WinBioFree を呼び出す必要があります。
WinBioEnumEnrollments を同期的に使用するには、WinBioOpenSession を呼び出して作成したセッション ハンドルを指定してこの関数を呼び出します。この関数は、操作が完了するかエラーが発生するまでブロックします。
WinBioEnumEnrollments を非同期的に使用するには、WinBioAsyncOpenSession を呼び出して作成したセッション ハンドルを指定してこの関数を呼び出します。フレームワークは WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成否に関する情報を返します。操作が成功した場合、フレームワークは入れ子になった EnumEnrollments 構造体で WINBIO_IDENTITY と WINBIO_BIOMETRIC_SUBTYPE の情報を返します。操作が失敗した場合、フレームワークはエラー情報を返します。WINBIO_ASYNC_RESULT 構造体は、WinBioAsyncOpenSession 関数の NotificationMethod パラメーターに設定した値に応じて、アプリケーションのコールバックまたはアプリケーションのメッセージ キューに返されます。
- コールバックを使用して完了通知を受け取る場合は、PWINBIO_ASYNC_COMPLETION_CALLBACK 関数を実装し、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_CALLBACK を設定する必要があります。
- アプリケーションのメッセージ キューを使用して完了通知を受け取る場合は、NotificationMethod パラメーターに WINBIO_ASYNC_NOTIFY_MESSAGE を設定する必要があります。フレームワークは、ウィンドウ メッセージの LPARAM フィールドに WINBIO_ASYNC_RESULT ポインターを返します。
例
次の関数は、WinBioEnumEnrollments を呼び出して、テンプレートに登録されている 生体サブファクターを列挙します。Winbio.lib スタティック ライブラリをリンクし、次のヘッダー ファイルをインクルードしてください。
- Windows.h
- Stdio.h
- Conio.h
- Winbio.h
HRESULT EnumEnrollments( )
{
// 変数を宣言します。
HRESULT hr = S_OK;
WINBIO_IDENTITY identity = {0};
WINBIO_SESSION_HANDLE sessionHandle = NULL;
WINBIO_UNIT_ID unitId = 0;
PWINBIO_BIOMETRIC_SUBTYPE subFactorArray = NULL;
WINBIO_BIOMETRIC_SUBTYPE SubFactor = 0;
SIZE_T subFactorCount = 0;
WINBIO_REJECT_DETAIL rejectDetail = 0;
WINBIO_BIOMETRIC_SUBTYPE subFactor = WINBIO_SUBTYPE_NO_INFORMATION;
// システム プールに接続します。
hr = WinBioOpenSession(
WINBIO_TYPE_FINGERPRINT, // サービス プロバイダー
WINBIO_POOL_SYSTEM, // プールの種類
WINBIO_FLAG_DEFAULT, // 構成とアクセス
NULL, // 生体認証ユニット ID の配列
0, // 生体認証ユニット ID の数
NULL, // データベース ID
&sessionHandle // [out] セッション ハンドル
);
if (FAILED(hr))
{
wprintf_s(L"\n WinBioOpenSession failed. hr = 0x%x\n", hr);
goto e_Exit;
}
// 生体認証センサーを検出し、WINBIO_IDENTITY オブジェクトを取得します。
wprintf_s(L"\n Calling WinBioIdentify - Swipe finger on sensor...\n");
hr = WinBioIdentify(
sessionHandle, // セッション ハンドル
&unitId, // 生体認証ユニット ID
&identity, // ユーザー SID
&subFactor, // 指のサブファクター
&rejectDetail // 拒否情報
);
wprintf_s(L"\n Swipe processed - Unit ID: %d\n", unitId);
if (FAILED(hr))
{
if (hr == WINBIO_E_UNKNOWN_ID)
{
wprintf_s(L"\n Unknown identity.\n");
}
else if (hr == WINBIO_E_BAD_CAPTURE)
{
wprintf_s(L"\n Bad capture; reason: %d\n", rejectDetail);
}
else
{
wprintf_s(L"\n WinBioEnumBiometricUnits failed. hr = 0x%x\n", hr);
}
goto e_Exit;
}
// テンプレートの生体サブファクターを取得します。
hr = WinBioEnumEnrollments(
sessionHandle, // セッション ハンドル
unitId, // 生体認証ユニット ID
&identity, // テンプレート ID
&subFactorArray, // サブファクター
&subFactorCount // サブファクターの数
);
if (FAILED(hr))
{
wprintf_s(L"\n WinBioEnumEnrollments failed. hr = 0x%x\n", hr);
goto e_Exit;
}
// サブファクターをコンソールに出力します。
wprintf_s(L"\n Enrollments for this user on Unit ID %d:", unitId);
for (SIZE_T index = 0; index < subFactorCount; ++index)
{
SubFactor = subFactorArray[index];
switch (SubFactor)
{
case WINBIO_ANSI_381_POS_RH_THUMB:
wprintf_s(L"\n RH thumb\n");
break;
case WINBIO_ANSI_381_POS_RH_INDEX_FINGER:
wprintf_s(L"\n RH index finger\n");
break;
case WINBIO_ANSI_381_POS_RH_MIDDLE_FINGER:
wprintf_s(L"\n RH middle finger\n");
break;
case WINBIO_ANSI_381_POS_RH_RING_FINGER:
wprintf_s(L"\n RH ring finger\n");
break;
case WINBIO_ANSI_381_POS_RH_LITTLE_FINGER:
wprintf_s(L"\n RH little finger\n");
break;
case WINBIO_ANSI_381_POS_LH_THUMB:
wprintf_s(L"\n LH thumb\n");
break;
case WINBIO_ANSI_381_POS_LH_INDEX_FINGER:
wprintf_s(L"\n LH index finger\n");
break;
case WINBIO_ANSI_381_POS_LH_MIDDLE_FINGER:
wprintf_s(L"\n LH middle finger\n");
break;
case WINBIO_ANSI_381_POS_LH_RING_FINGER:
wprintf_s(L"\n LH ring finger\n");
break;
case WINBIO_ANSI_381_POS_LH_LITTLE_FINGER:
wprintf_s(L"\n LH little finger\n");
break;
default:
wprintf_s(L"\n The sub-factor is not correct\n");
break;
}
}
e_Exit:
if (subFactorArray!= NULL)
{
WinBioFree(subFactorArray);
subFactorArray = NULL;
}
if (sessionHandle != NULL)
{
WinBioCloseSession(sessionHandle);
sessionHandle = NULL;
}
wprintf_s(L"\n Press any key to exit...");
_getch();
return hr;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// winbio.dll
#include <windows.h>
HRESULT WinBioEnumEnrollments(
DWORD SessionHandle,
DWORD UnitId,
WINBIO_IDENTITY* Identity,
BYTE** SubFactorArray,
UINT_PTR* SubFactorCount // optional
);[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioEnumEnrollments(
uint SessionHandle, // DWORD
uint UnitId, // DWORD
IntPtr Identity, // WINBIO_IDENTITY*
IntPtr SubFactorArray, // BYTE** out
IntPtr SubFactorCount // UINT_PTR* optional, out
);<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioEnumEnrollments(
SessionHandle As UInteger, ' DWORD
UnitId As UInteger, ' DWORD
Identity As IntPtr, ' WINBIO_IDENTITY*
SubFactorArray As IntPtr, ' BYTE** out
SubFactorCount As IntPtr ' UINT_PTR* optional, out
) As Integer
End Function' SessionHandle : DWORD
' UnitId : DWORD
' Identity : WINBIO_IDENTITY*
' SubFactorArray : BYTE** out
' SubFactorCount : UINT_PTR* optional, out
Declare PtrSafe Function WinBioEnumEnrollments Lib "winbio" ( _
ByVal SessionHandle As Long, _
ByVal UnitId As Long, _
ByVal Identity As LongPtr, _
ByVal SubFactorArray As LongPtr, _
ByVal SubFactorCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WinBioEnumEnrollments = ctypes.windll.winbio.WinBioEnumEnrollments
WinBioEnumEnrollments.restype = ctypes.c_int
WinBioEnumEnrollments.argtypes = [
wintypes.DWORD, # SessionHandle : DWORD
wintypes.DWORD, # UnitId : DWORD
ctypes.c_void_p, # Identity : WINBIO_IDENTITY*
ctypes.c_void_p, # SubFactorArray : BYTE** out
ctypes.POINTER(ctypes.c_size_t), # SubFactorCount : UINT_PTR* optional, out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('winbio.dll')
WinBioEnumEnrollments = Fiddle::Function.new(
lib['WinBioEnumEnrollments'],
[
-Fiddle::TYPE_INT, # SessionHandle : DWORD
-Fiddle::TYPE_INT, # UnitId : DWORD
Fiddle::TYPE_VOIDP, # Identity : WINBIO_IDENTITY*
Fiddle::TYPE_VOIDP, # SubFactorArray : BYTE** out
Fiddle::TYPE_VOIDP, # SubFactorCount : UINT_PTR* optional, out
],
Fiddle::TYPE_INT)#[link(name = "winbio")]
extern "system" {
fn WinBioEnumEnrollments(
SessionHandle: u32, // DWORD
UnitId: u32, // DWORD
Identity: *mut WINBIO_IDENTITY, // WINBIO_IDENTITY*
SubFactorArray: *mut *mut u8, // BYTE** out
SubFactorCount: *mut usize // UINT_PTR* optional, out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioEnumEnrollments(uint SessionHandle, uint UnitId, IntPtr Identity, IntPtr SubFactorArray, IntPtr SubFactorCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioEnumEnrollments' -Namespace Win32 -PassThru
# $api::WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)#uselib "winbio.dll"
#func global WinBioEnumEnrollments "WinBioEnumEnrollments" sptr, sptr, sptr, sptr, sptr
; WinBioEnumEnrollments SessionHandle, UnitId, varptr(Identity), varptr(SubFactorArray), varptr(SubFactorCount) ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; UnitId : DWORD -> "sptr"
; Identity : WINBIO_IDENTITY* -> "sptr"
; SubFactorArray : BYTE** out -> "sptr"
; SubFactorCount : UINT_PTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "winbio.dll" #cfunc global WinBioEnumEnrollments "WinBioEnumEnrollments" int, int, var, var, var ; res = WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount) ; SessionHandle : DWORD -> "int" ; UnitId : DWORD -> "int" ; Identity : WINBIO_IDENTITY* -> "var" ; SubFactorArray : BYTE** out -> "var" ; SubFactorCount : UINT_PTR* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll" #cfunc global WinBioEnumEnrollments "WinBioEnumEnrollments" int, int, sptr, sptr, sptr ; res = WinBioEnumEnrollments(SessionHandle, UnitId, varptr(Identity), varptr(SubFactorArray), varptr(SubFactorCount)) ; SessionHandle : DWORD -> "int" ; UnitId : DWORD -> "int" ; Identity : WINBIO_IDENTITY* -> "sptr" ; SubFactorArray : BYTE** out -> "sptr" ; SubFactorCount : UINT_PTR* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT WinBioEnumEnrollments(DWORD SessionHandle, DWORD UnitId, WINBIO_IDENTITY* Identity, BYTE** SubFactorArray, UINT_PTR* SubFactorCount) #uselib "winbio.dll" #cfunc global WinBioEnumEnrollments "WinBioEnumEnrollments" int, int, var, var, var ; res = WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount) ; SessionHandle : DWORD -> "int" ; UnitId : DWORD -> "int" ; Identity : WINBIO_IDENTITY* -> "var" ; SubFactorArray : BYTE** out -> "var" ; SubFactorCount : UINT_PTR* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WinBioEnumEnrollments(DWORD SessionHandle, DWORD UnitId, WINBIO_IDENTITY* Identity, BYTE** SubFactorArray, UINT_PTR* SubFactorCount) #uselib "winbio.dll" #cfunc global WinBioEnumEnrollments "WinBioEnumEnrollments" int, int, intptr, intptr, intptr ; res = WinBioEnumEnrollments(SessionHandle, UnitId, varptr(Identity), varptr(SubFactorArray), varptr(SubFactorCount)) ; SessionHandle : DWORD -> "int" ; UnitId : DWORD -> "int" ; Identity : WINBIO_IDENTITY* -> "intptr" ; SubFactorArray : BYTE** out -> "intptr" ; SubFactorCount : UINT_PTR* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winbio = windows.NewLazySystemDLL("winbio.dll")
procWinBioEnumEnrollments = winbio.NewProc("WinBioEnumEnrollments")
)
// SessionHandle (DWORD), UnitId (DWORD), Identity (WINBIO_IDENTITY*), SubFactorArray (BYTE** out), SubFactorCount (UINT_PTR* optional, out)
r1, _, err := procWinBioEnumEnrollments.Call(
uintptr(SessionHandle),
uintptr(UnitId),
uintptr(Identity),
uintptr(SubFactorArray),
uintptr(SubFactorCount),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction WinBioEnumEnrollments(
SessionHandle: DWORD; // DWORD
UnitId: DWORD; // DWORD
Identity: Pointer; // WINBIO_IDENTITY*
SubFactorArray: Pointer; // BYTE** out
SubFactorCount: Pointer // UINT_PTR* optional, out
): Integer; stdcall;
external 'winbio.dll' name 'WinBioEnumEnrollments';result := DllCall("winbio\WinBioEnumEnrollments"
, "UInt", SessionHandle ; DWORD
, "UInt", UnitId ; DWORD
, "Ptr", Identity ; WINBIO_IDENTITY*
, "Ptr", SubFactorArray ; BYTE** out
, "Ptr", SubFactorCount ; UINT_PTR* optional, out
, "Int") ; return: HRESULT●WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount) = DLL("winbio.dll", "int WinBioEnumEnrollments(dword, dword, void*, void*, void*)")
# 呼び出し: WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)
# SessionHandle : DWORD -> "dword"
# UnitId : DWORD -> "dword"
# Identity : WINBIO_IDENTITY* -> "void*"
# SubFactorArray : BYTE** out -> "void*"
# SubFactorCount : UINT_PTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winbio" fn WinBioEnumEnrollments(
SessionHandle: u32, // DWORD
UnitId: u32, // DWORD
Identity: [*c]WINBIO_IDENTITY, // WINBIO_IDENTITY*
SubFactorArray: [*c][*c]u8, // BYTE** out
SubFactorCount: [*c]usize // UINT_PTR* optional, out
) callconv(std.os.windows.WINAPI) i32;proc WinBioEnumEnrollments(
SessionHandle: uint32, # DWORD
UnitId: uint32, # DWORD
Identity: ptr WINBIO_IDENTITY, # WINBIO_IDENTITY*
SubFactorArray: ptr uint8, # BYTE** out
SubFactorCount: ptr uint # UINT_PTR* optional, out
): int32 {.importc: "WinBioEnumEnrollments", stdcall, dynlib: "winbio.dll".}pragma(lib, "winbio");
extern(Windows)
int WinBioEnumEnrollments(
uint SessionHandle, // DWORD
uint UnitId, // DWORD
WINBIO_IDENTITY* Identity, // WINBIO_IDENTITY*
ubyte** SubFactorArray, // BYTE** out
size_t* SubFactorCount // UINT_PTR* optional, out
);ccall((:WinBioEnumEnrollments, "winbio.dll"), stdcall, Int32,
(UInt32, UInt32, Ptr{WINBIO_IDENTITY}, Ptr{UInt8}, Ptr{Csize_t}),
SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)
# SessionHandle : DWORD -> UInt32
# UnitId : DWORD -> UInt32
# Identity : WINBIO_IDENTITY* -> Ptr{WINBIO_IDENTITY}
# SubFactorArray : BYTE** out -> Ptr{UInt8}
# SubFactorCount : UINT_PTR* optional, out -> Ptr{Csize_t}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioEnumEnrollments(
uint32_t SessionHandle,
uint32_t UnitId,
void* Identity,
uint8_t** SubFactorArray,
uintptr_t* SubFactorCount);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)
-- SessionHandle : DWORD
-- UnitId : DWORD
-- Identity : WINBIO_IDENTITY*
-- SubFactorArray : BYTE** out
-- SubFactorCount : UINT_PTR* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioEnumEnrollments = lib.func('__stdcall', 'WinBioEnumEnrollments', 'int32_t', ['uint32_t', 'uint32_t', 'void *', 'uint8_t *', 'uintptr_t *']);
// WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)
// SessionHandle : DWORD -> 'uint32_t'
// UnitId : DWORD -> 'uint32_t'
// Identity : WINBIO_IDENTITY* -> 'void *'
// SubFactorArray : BYTE** out -> 'uint8_t *'
// SubFactorCount : UINT_PTR* optional, out -> 'uintptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("winbio.dll", {
WinBioEnumEnrollments: { parameters: ["u32", "u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount)
// SessionHandle : DWORD -> "u32"
// UnitId : DWORD -> "u32"
// Identity : WINBIO_IDENTITY* -> "pointer"
// SubFactorArray : BYTE** out -> "pointer"
// SubFactorCount : UINT_PTR* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioEnumEnrollments(
uint32_t SessionHandle,
uint32_t UnitId,
void* Identity,
uint8_t** SubFactorArray,
size_t* SubFactorCount);
C, "winbio.dll");
// $ffi->WinBioEnumEnrollments(SessionHandle, UnitId, Identity, SubFactorArray, SubFactorCount);
// SessionHandle : DWORD
// UnitId : DWORD
// Identity : WINBIO_IDENTITY*
// SubFactorArray : BYTE** out
// SubFactorCount : UINT_PTR* 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 WinBioEnumEnrollments(
int SessionHandle, // DWORD
int UnitId, // DWORD
Pointer Identity, // WINBIO_IDENTITY*
Pointer SubFactorArray, // BYTE** out
LongByReference SubFactorCount // UINT_PTR* optional, out
);
}@[Link("winbio")]
lib Libwinbio
fun WinBioEnumEnrollments = WinBioEnumEnrollments(
SessionHandle : UInt32, # DWORD
UnitId : UInt32, # DWORD
Identity : WINBIO_IDENTITY*, # WINBIO_IDENTITY*
SubFactorArray : UInt8**, # BYTE** out
SubFactorCount : LibC::SizeT* # UINT_PTR* 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 WinBioEnumEnrollmentsNative = Int32 Function(Uint32, Uint32, Pointer<Void>, Pointer<Uint8>, Pointer<UintPtr>);
typedef WinBioEnumEnrollmentsDart = int Function(int, int, Pointer<Void>, Pointer<Uint8>, Pointer<UintPtr>);
final WinBioEnumEnrollments = DynamicLibrary.open('winbio.dll')
.lookupFunction<WinBioEnumEnrollmentsNative, WinBioEnumEnrollmentsDart>('WinBioEnumEnrollments');
// SessionHandle : DWORD -> Uint32
// UnitId : DWORD -> Uint32
// Identity : WINBIO_IDENTITY* -> Pointer<Void>
// SubFactorArray : BYTE** out -> Pointer<Uint8>
// SubFactorCount : UINT_PTR* optional, out -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinBioEnumEnrollments(
SessionHandle: DWORD; // DWORD
UnitId: DWORD; // DWORD
Identity: Pointer; // WINBIO_IDENTITY*
SubFactorArray: Pointer; // BYTE** out
SubFactorCount: Pointer // UINT_PTR* optional, out
): Integer; stdcall;
external 'winbio.dll' name 'WinBioEnumEnrollments';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinBioEnumEnrollments"
c_WinBioEnumEnrollments :: Word32 -> Word32 -> Ptr () -> Ptr Word8 -> Ptr CUIntPtr -> IO Int32
-- SessionHandle : DWORD -> Word32
-- UnitId : DWORD -> Word32
-- Identity : WINBIO_IDENTITY* -> Ptr ()
-- SubFactorArray : BYTE** out -> Ptr Word8
-- SubFactorCount : UINT_PTR* optional, out -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winbioenumenrollments =
foreign "WinBioEnumEnrollments"
(uint32_t @-> uint32_t @-> (ptr void) @-> (ptr uint8_t) @-> (ptr size_t) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* UnitId : DWORD -> uint32_t *)
(* Identity : WINBIO_IDENTITY* -> (ptr void) *)
(* SubFactorArray : BYTE** out -> (ptr uint8_t) *)
(* SubFactorCount : UINT_PTR* optional, out -> (ptr size_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)
(cffi:defcfun ("WinBioEnumEnrollments" win-bio-enum-enrollments :convention :stdcall) :int32
(session-handle :uint32) ; DWORD
(unit-id :uint32) ; DWORD
(identity :pointer) ; WINBIO_IDENTITY*
(sub-factor-array :pointer) ; BYTE** out
(sub-factor-count :pointer)) ; UINT_PTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinBioEnumEnrollments = Win32::API::More->new('winbio',
'int WinBioEnumEnrollments(DWORD SessionHandle, DWORD UnitId, LPVOID Identity, LPVOID SubFactorArray, LPVOID SubFactorCount)');
# my $ret = $WinBioEnumEnrollments->Call($SessionHandle, $UnitId, $Identity, $SubFactorArray, $SubFactorCount);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD -> DWORD
# Identity : WINBIO_IDENTITY* -> LPVOID
# SubFactorArray : BYTE** out -> LPVOID
# SubFactorCount : UINT_PTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WinBioEnumBiometricUnits — 指定した生体認証要素の生体認証ユニット一覧を列挙する。
- f WinBioEnumDatabases — 指定した生体認証要素のデータベース一覧を列挙する。
- f WinBioEnumServiceProviders — 指定した生体認証要素のサービスプロバイダ一覧を列挙する。