ホーム › Devices.BiometricFramework › WinBioEnumDatabases

WinBioEnumDatabases

関数

指定した生体認証要素のデータベース一覧を列挙する。

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

シグネチャ

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

HRESULT WinBioEnumDatabases(
    DWORD Factor,
    WINBIO_STORAGE_SCHEMA** StorageSchemaArray,
    UINT_PTR* StorageCount
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

指定した種類に一致する、登録済みのすべてのデータベースを列挙します。

戻り値

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

戻り値	説明
E_INVALIDARG	Factor パラメーターに含まれるビットマスクに、1 つ以上の無効な種類のビットが含まれています。
E_OUTOFMEMORY	要求を完了するための十分なメモリがありませんでした。
E_POINTER	StorageSchemaArray パラメーターと StorageCount パラメーターに NULL を指定することはできません。

解説(Remarks)

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

StorageSchemaArray パラメーターが指す構造体の配列に複数のデータベースの情報が返される場合、それらのデータベースが特定の順序で並んでいることは保証されません。

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

例

次のコード例では、WinBioEnumDatabases を呼び出して、システム上の生体認証データベースを列挙します。この例には、データベース ID を表示する DisplayGuid 関数も含まれています。Winbio.lib スタティックライブラリをリンクし、次のヘッダーファイルをインクルードしてください。

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

HRESULT EnumDatabases( )
{
    // 変数を宣言します。
    HRESULT hr = S_OK;
    PWINBIO_STORAGE_SCHEMA storageSchemaArray = NULL;
    SIZE_T storageCount = 0;
    SIZE_T index = 0;

    // データベースを列挙します。
    hr = WinBioEnumDatabases( 
            WINBIO_TYPE_FINGERPRINT,    // 生体認証ユニットの種類
            &storageSchemaArray,        // データベーススキーマの配列
            &storageCount );            // データベーススキーマの数
    if (FAILED(hr))
    {
        wprintf_s(L"\nWinBioEnumDatabases failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // 各データベースの情報を表示します。
    wprintf_s(L"\nDatabases:\n");
    for (index = 0; index < storageCount; ++index)
    {
        wprintf_s(L"\n[%d]: \tBiometric factor: 0x%08x\n", 
                 index, 
                 storageSchemaArray[index].BiometricFactor );
        
        wprintf_s(L"\tDatabase ID: ");
        DisplayGuid(&storageSchemaArray[index].DatabaseId);
        wprintf_s(L"\n");

        wprintf_s(L"\tData format: ");
        DisplayGuid(&storageSchemaArray[index].DataFormat);
        wprintf_s(L"\n");

        wprintf_s(L"\tAttributes:  0x%08x\n", 
                 storageSchemaArray[index].Attributes);

        wprintf_s(L"\tFile path:   %ws\n", 
                 storageSchemaArray[index].FilePath );

        wprintf_s(L"\tCnx string:  %ws\n", 
                 storageSchemaArray[index].ConnectionString );

        wprintf_s(L"\n");
    }

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

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

    return hr;
}


//------------------------------------------------------------------------
// 次の関数は、GUID をコンソールウィンドウに表示します。
//
VOID DisplayGuid( __in PWINBIO_UUID Guid )
{
    wprintf_s(
        L"{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
        Guid->Data1,
        Guid->Data2,
        Guid->Data3,
        Guid->Data4[0],
        Guid->Data4[1],
        Guid->Data4[2],
        Guid->Data4[3],
        Guid->Data4[4],
        Guid->Data4[5],
        Guid->Data4[6],
        Guid->Data4[7]
        );
}

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

各言語での呼び出し定義

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

HRESULT WinBioEnumDatabases(
    DWORD Factor,
    WINBIO_STORAGE_SCHEMA** StorageSchemaArray,
    UINT_PTR* StorageCount
);

[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioEnumDatabases(
    uint Factor,   // DWORD
    IntPtr StorageSchemaArray,   // WINBIO_STORAGE_SCHEMA** out
    out UIntPtr StorageCount   // UINT_PTR* out
);

<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioEnumDatabases(
    Factor As UInteger,   ' DWORD
    StorageSchemaArray As IntPtr,   ' WINBIO_STORAGE_SCHEMA** out
    <Out> ByRef StorageCount As UIntPtr   ' UINT_PTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

WinBioEnumDatabases = ctypes.windll.winbio.WinBioEnumDatabases
WinBioEnumDatabases.restype = ctypes.c_int
WinBioEnumDatabases.argtypes = [
    wintypes.DWORD,  # Factor : DWORD
    ctypes.c_void_p,  # StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out
    ctypes.POINTER(ctypes.c_size_t),  # StorageCount : UINT_PTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioEnumDatabases = Fiddle::Function.new(
  lib['WinBioEnumDatabases'],
  [
    -Fiddle::TYPE_INT,  # Factor : DWORD
    Fiddle::TYPE_VOIDP,  # StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out
    Fiddle::TYPE_VOIDP,  # StorageCount : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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