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

WinBioEnumEnrollments

関数
指定IDに登録済みの生体サブ要素一覧を列挙する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WinBioEnumEnrollments(
    DWORD SessionHandle,
    DWORD UnitId,
    WINBIO_IDENTITY* Identity,
    BYTE** SubFactorArray,
    UINT_PTR* SubFactorCount   // optional
);

パラメーター

名前型方向説明
SessionHandleDWORDin登録一覧取得に用いるセッションのハンドル。
UnitIdDWORDin列挙対象のバイオメトリックユニットのID。
IdentityWINBIO_IDENTITY*in登録を列挙する対象ユーザーのIDを指定する構造体ポインタ。
SubFactorArrayBYTE**out登録済み下位ファクターの配列を受け取る出力ポインタ。要WinBioFreeで解放。
SubFactorCountUINT_PTR*outoptional返された配列の要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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   // HRESULT
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';
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 を使用。

関連項目

使用する型