ホーム › Devices.BiometricFramework › WinBioEnumBiometricUnits

WinBioEnumBiometricUnits

関数

指定した生体認証要素の生体認証ユニット一覧を列挙する。

DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioEnumBiometricUnits(
    DWORD Factor,
    WINBIO_UNIT_SCHEMA** UnitSchemaArray,
    UINT_PTR* UnitCount
);

パラメーター

名前	型	方向	説明
Factor	DWORD	in	列挙するバイオメトリックユニットの種類を指定する WINBIO_BIOMETRIC_TYPE フラグのビットマスク。現在サポートされているのは WINBIO_TYPE_FINGERPRINT のみです。
UnitSchemaArray	WINBIO_UNIT_SCHEMA**	out	列挙された各バイオメトリックユニットの情報を格納する WINBIO_UNIT_SCHEMA 構造体の配列へのポインターを受け取る変数のアドレス。関数が成功しなかった場合、このポインターには NULL が設定されます。関数が成功した場合は、配列用に内部で割り当てられたメモリを解放するために、このポインターを WinBioFree に渡す必要があります。
UnitCount	UINT_PTR*	out	UnitSchemaArray パラメーターが指す構造体の数を格納する値へのポインター。

戻り値の型: HRESULT

公式ドキュメント

入力された種類に一致する、接続されているすべてのバイオメトリックユニットを列挙します。

戻り値

関数が成功すると S_OK を返します。失敗した場合は、エラーを示す HRESULT 値を返します。想定される値には、次の表に示すものが含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

戻り値	説明
E_INVALIDARG	Factor パラメーターに含まれるビットマスクに、1 つ以上の無効な種類のビットが含まれています。
E_OUTOFMEMORY	要求を完了するためのメモリが不足していました。
E_POINTER	UnitSchemaArray パラメーターおよび UnitCount パラメーターに NULL を指定することはできません。
WINBIO_E_DISABLED	現在の管理ポリシーにより、Windows Biometric Framework API の使用が禁止されています。

解説(Remarks)

Factor パラメーターで現在サポートされているのは WINBIO_TYPE_FINGERPRINT のみです。

UnitSchemaArray パラメーターが指す構造体の配列に、インストールされている複数のバイオメトリックユニットの情報が返される場合、それらのユニットが特定の順序で並んでいることは保証されません。

UnitSchemaArray パラメーターに返された構造体の使用を終えたら、配列用に内部で割り当てられたメモリを解放するために WinBioFree を呼び出す必要があります。

Factor ビットマスク内のすべての factor ビットが、サポートされていないバイオメトリックの種類を指している場合、関数は S_OK を返しますが、UnitSchemaArray パラメーターが指す値は NULL になり、UnitCount パラメーターには 0 が格納されます。サポートされていないバイオメトリック要素について問い合わせてもエラーではありませんが、クエリの結果は空のセットになります。

例

次の関数は、WinBioEnumBiometricUnits を呼び出して、インストールされているバイオメトリックユニットを列挙します。Winbio.lib 静的ライブラリにリンクし、次のヘッダーファイルをインクルードしてください。

Windows.h
Stdio.h
Conio.h
Winbio.h

HRESULT EnumerateSensors( )
{
    // Declare variables.
    HRESULT hr = S_OK;
    PWINBIO_UNIT_SCHEMA unitSchema = NULL;
    SIZE_T unitCount = 0;
    SIZE_T index = 0;

    // Enumerate the installed biometric units.
    hr = WinBioEnumBiometricUnits( 
            WINBIO_TYPE_FINGERPRINT,        // Type of biometric unit
            &unitSchema,                    // Array of unit schemas
            &unitCount );                   // Count of unit schemas

    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnumBiometricUnits failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Display information for each installed biometric unit.
    wprintf_s(L"\nSensors: \n");
    for (index = 0; index < unitCount; ++index)
    {
        wprintf_s(L"\n[%d]: \tUnit ID: %d\n", 
                 index, 
                 unitSchema[index].UnitId );
        wprintf_s(L"\tDevice instance ID: %s\n", 
                 unitSchema[index].DeviceInstanceId );
        wprintf_s(L"\tPool type: %d\n", 
                 unitSchema[index].PoolType );
        wprintf_s(L"\tBiometric factor: %d\n", 
                 unitSchema[index].BiometricFactor );
        wprintf_s(L"\tSensor subtype: %d\n", 
                 unitSchema[index].SensorSubType );
        wprintf_s(L"\tSensor capabilities: 0x%08x\n", 
                 unitSchema[index].Capabilities );
        wprintf_s(L"\tDescription: %s\n", 
                 unitSchema[index].Description );
        wprintf_s(L"\tManufacturer: %s\n", 
                 unitSchema[index].Manufacturer );
        wprintf_s(L"\tModel: %s\n", 
                 unitSchema[index].Model );
        wprintf_s(L"\tSerial no: %s\n", 
                 unitSchema[index].SerialNumber );
        wprintf_s(L"\tFirmware version: [%d.%d]\n", 
                 unitSchema[index].FirmwareVersion.MajorVersion, 
                 unitSchema[index].FirmwareVersion.MinorVersion);
    }


e_Exit:
    if (unitSchema != NULL)
    {
        WinBioFree(unitSchema);
        unitSchema = NULL;
    }

    wprintf_s(L"\nPress any key to exit...");
    _getch();

    return hr;
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT WinBioEnumBiometricUnits(
    DWORD Factor,
    WINBIO_UNIT_SCHEMA** UnitSchemaArray,
    UINT_PTR* UnitCount
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioEnumBiometricUnits(
    uint Factor,   // DWORD
    IntPtr UnitSchemaArray,   // WINBIO_UNIT_SCHEMA** out
    out UIntPtr UnitCount   // UINT_PTR* out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioEnumBiometricUnits(
    Factor As UInteger,   ' DWORD
    UnitSchemaArray As IntPtr,   ' WINBIO_UNIT_SCHEMA** out
    <Out> ByRef UnitCount As UIntPtr   ' UINT_PTR* out
) As Integer
End Function

' Factor : DWORD
' UnitSchemaArray : WINBIO_UNIT_SCHEMA** out
' UnitCount : UINT_PTR* out
Declare PtrSafe Function WinBioEnumBiometricUnits Lib "winbio" ( _
    ByVal Factor As Long, _
    ByVal UnitSchemaArray As LongPtr, _
    ByRef UnitCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinBioEnumBiometricUnits = ctypes.windll.winbio.WinBioEnumBiometricUnits
WinBioEnumBiometricUnits.restype = ctypes.c_int
WinBioEnumBiometricUnits.argtypes = [
    wintypes.DWORD,  # Factor : DWORD
    ctypes.c_void_p,  # UnitSchemaArray : WINBIO_UNIT_SCHEMA** out
    ctypes.POINTER(ctypes.c_size_t),  # UnitCount : UINT_PTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioEnumBiometricUnits = Fiddle::Function.new(
  lib['WinBioEnumBiometricUnits'],
  [
    -Fiddle::TYPE_INT,  # Factor : DWORD
    Fiddle::TYPE_VOIDP,  # UnitSchemaArray : WINBIO_UNIT_SCHEMA** out
    Fiddle::TYPE_VOIDP,  # UnitCount : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winbio")]
extern "system" {
    fn WinBioEnumBiometricUnits(
        Factor: u32,  // DWORD
        UnitSchemaArray: *mut *mut WINBIO_UNIT_SCHEMA,  // WINBIO_UNIT_SCHEMA** out
        UnitCount: *mut usize  // UINT_PTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioEnumBiometricUnits(uint Factor, IntPtr UnitSchemaArray, out UIntPtr UnitCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioEnumBiometricUnits' -Namespace Win32 -PassThru
# $api::WinBioEnumBiometricUnits(Factor, UnitSchemaArray, UnitCount)

#uselib "winbio.dll"
#func global WinBioEnumBiometricUnits "WinBioEnumBiometricUnits" sptr, sptr, sptr
; WinBioEnumBiometricUnits Factor, varptr(UnitSchemaArray), varptr(UnitCount)   ; 戻り値は stat
; Factor : DWORD -> "sptr"
; UnitSchemaArray : WINBIO_UNIT_SCHEMA** out -> "sptr"
; UnitCount : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winbio.dll"
#cfunc global WinBioEnumBiometricUnits "WinBioEnumBiometricUnits" int, var, var
; res = WinBioEnumBiometricUnits(Factor, UnitSchemaArray, UnitCount)
; Factor : DWORD -> "int"
; UnitSchemaArray : WINBIO_UNIT_SCHEMA** out -> "var"
; UnitCount : UINT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winbio.dll"
#cfunc global WinBioEnumBiometricUnits "WinBioEnumBiometricUnits" int, sptr, sptr
; res = WinBioEnumBiometricUnits(Factor, varptr(UnitSchemaArray), varptr(UnitCount))
; Factor : DWORD -> "int"
; UnitSchemaArray : WINBIO_UNIT_SCHEMA** out -> "sptr"
; UnitCount : UINT_PTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。