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

WinBioAsyncEnumDatabases

関数
生体認証データベース一覧を非同期に列挙する。
DLLwinbio.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WinBioAsyncEnumDatabases(
    DWORD FrameworkHandle,
    DWORD Factor
);

パラメーター

名前型方向説明
FrameworkHandleDWORDinWinBioAsyncOpenFramework を呼び出して開いたフレームワークセッションのハンドル。
FactorDWORDin列挙するバイオメトリックデータベースの種類を指定する WINBIO_BIOMETRIC_TYPE フラグのビットマスク。現在サポートされているのは WINBIO_TYPE_FINGERPRINT のみです。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

この関数は、成功または失敗を示す HRESULT を返します。成功は、関数の引数が有効であったことのみを示す点に注意してください。操作の実行中に発生した失敗は、WinBioAsyncOpenFramework の呼び出しで指定した通知方法を使用して、WINBIO_ASYNC_RESULT 構造体に非同期に返されます。

戻り値 説明
E_HANDLE
FrameworkHandle 引数を設定する必要があります。
E_INVALIDARG
Factor パラメーターに含まれるビットマスクに、1 つ以上の無効な種類のビットが含まれています。
E_OUTOFMEMORY
要求を完了するための十分なメモリがありませんでした。
WINBIO_E_INCORRECT_SESSION_TYPE
FrameworkHandle 引数は、非同期のフレームワークセッションを表している必要があります。

解説(Remarks)

WinBioAsyncEnumDatabases 関数は、WinBioAsyncOpenFramework を呼び出して開いたフレームワークセッションのハンドルを使用します。 フレームワークは WINBIO_ASYNC_RESULT 構造体を割り当て、 それを使用して操作の成功または失敗に関する情報を返します。列挙操作が成功した場合、フレームワークは列挙された各データベースに関する情報を含むスキーマの配列を返します。操作が失敗した場合、フレームワークは WINBIO_ASYNC_RESULT 構造体を使用してエラー情報を返します。この構造体は、WinBioAsyncOpenFramework 関数の NotificationMethod パラメーターに設定した値に応じて、アプリケーションのコールバックまたはアプリケーションのメッセージキューに返されます。

スキーマの配列は、WINBIO_ASYNC_RESULT 構造体の内部に入れ子になった EnumDatabases 構造体に格納されて返されます。使用が終わったら、WinBioFree を呼び出して WINBIO_ASYNC_RESULT 構造体を解放する必要があります。

WinBioAsyncEnumDatabases を呼び出すと、クライアントアプリケーションに 1 件の通知が送信されます。

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

各言語での呼び出し定義

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

HRESULT WinBioAsyncEnumDatabases(
    DWORD FrameworkHandle,
    DWORD Factor
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioAsyncEnumDatabases(
    uint FrameworkHandle,   // DWORD
    uint Factor   // DWORD
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioAsyncEnumDatabases(
    FrameworkHandle As UInteger,   ' DWORD
    Factor As UInteger   ' DWORD
) As Integer
End Function
' FrameworkHandle : DWORD
' Factor : DWORD
Declare PtrSafe Function WinBioAsyncEnumDatabases Lib "winbio" ( _
    ByVal FrameworkHandle As Long, _
    ByVal Factor As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinBioAsyncEnumDatabases = ctypes.windll.winbio.WinBioAsyncEnumDatabases
WinBioAsyncEnumDatabases.restype = ctypes.c_int
WinBioAsyncEnumDatabases.argtypes = [
    wintypes.DWORD,  # FrameworkHandle : DWORD
    wintypes.DWORD,  # Factor : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winbio.dll')
WinBioAsyncEnumDatabases = Fiddle::Function.new(
  lib['WinBioAsyncEnumDatabases'],
  [
    -Fiddle::TYPE_INT,  # FrameworkHandle : DWORD
    -Fiddle::TYPE_INT,  # Factor : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winbio")]
extern "system" {
    fn WinBioAsyncEnumDatabases(
        FrameworkHandle: u32,  // DWORD
        Factor: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winbio.dll")]
public static extern int WinBioAsyncEnumDatabases(uint FrameworkHandle, uint Factor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioAsyncEnumDatabases' -Namespace Win32 -PassThru
# $api::WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
#uselib "winbio.dll"
#func global WinBioAsyncEnumDatabases "WinBioAsyncEnumDatabases" sptr, sptr
; WinBioAsyncEnumDatabases FrameworkHandle, Factor   ; 戻り値は stat
; FrameworkHandle : DWORD -> "sptr"
; Factor : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winbio.dll"
#cfunc global WinBioAsyncEnumDatabases "WinBioAsyncEnumDatabases" int, int
; res = WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
; FrameworkHandle : DWORD -> "int"
; Factor : DWORD -> "int"
; HRESULT WinBioAsyncEnumDatabases(DWORD FrameworkHandle, DWORD Factor)
#uselib "winbio.dll"
#cfunc global WinBioAsyncEnumDatabases "WinBioAsyncEnumDatabases" int, int
; res = WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
; FrameworkHandle : DWORD -> "int"
; Factor : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioAsyncEnumDatabases = winbio.NewProc("WinBioAsyncEnumDatabases")
)

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

extern "winbio" fn WinBioAsyncEnumDatabases(
    FrameworkHandle: u32, // DWORD
    Factor: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WinBioAsyncEnumDatabases(
    FrameworkHandle: uint32,  # DWORD
    Factor: uint32  # DWORD
): int32 {.importc: "WinBioAsyncEnumDatabases", stdcall, dynlib: "winbio.dll".}
pragma(lib, "winbio");
extern(Windows)
int WinBioAsyncEnumDatabases(
    uint FrameworkHandle,   // DWORD
    uint Factor   // DWORD
);
ccall((:WinBioAsyncEnumDatabases, "winbio.dll"), stdcall, Int32,
      (UInt32, UInt32),
      FrameworkHandle, Factor)
# FrameworkHandle : DWORD -> UInt32
# Factor : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioAsyncEnumDatabases(
    uint32_t FrameworkHandle,
    uint32_t Factor);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
-- FrameworkHandle : DWORD
-- Factor : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioAsyncEnumDatabases = lib.func('__stdcall', 'WinBioAsyncEnumDatabases', 'int32_t', ['uint32_t', 'uint32_t']);
// WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
// FrameworkHandle : DWORD -> 'uint32_t'
// Factor : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winbio.dll", {
  WinBioAsyncEnumDatabases: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.WinBioAsyncEnumDatabases(FrameworkHandle, Factor)
// FrameworkHandle : DWORD -> "u32"
// Factor : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioAsyncEnumDatabases(
    uint32_t FrameworkHandle,
    uint32_t Factor);
C, "winbio.dll");
// $ffi->WinBioAsyncEnumDatabases(FrameworkHandle, Factor);
// FrameworkHandle : DWORD
// Factor : DWORD
// 構造体/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 WinBioAsyncEnumDatabases(
        int FrameworkHandle,   // DWORD
        int Factor   // DWORD
    );
}
@[Link("winbio")]
lib Libwinbio
  fun WinBioAsyncEnumDatabases = WinBioAsyncEnumDatabases(
    FrameworkHandle : UInt32,   # DWORD
    Factor : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinBioAsyncEnumDatabasesNative = Int32 Function(Uint32, Uint32);
typedef WinBioAsyncEnumDatabasesDart = int Function(int, int);
final WinBioAsyncEnumDatabases = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioAsyncEnumDatabasesNative, WinBioAsyncEnumDatabasesDart>('WinBioAsyncEnumDatabases');
// FrameworkHandle : DWORD -> Uint32
// Factor : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioAsyncEnumDatabases(
  FrameworkHandle: DWORD;   // DWORD
  Factor: DWORD   // DWORD
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioAsyncEnumDatabases';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioAsyncEnumDatabases"
  c_WinBioAsyncEnumDatabases :: Word32 -> Word32 -> IO Int32
-- FrameworkHandle : DWORD -> Word32
-- Factor : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbioasyncenumdatabases =
  foreign "WinBioAsyncEnumDatabases"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* FrameworkHandle : DWORD -> uint32_t *)
(* Factor : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioAsyncEnumDatabases" win-bio-async-enum-databases :convention :stdcall) :int32
  (framework-handle :uint32)   ; DWORD
  (factor :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioAsyncEnumDatabases = Win32::API::More->new('winbio',
    'int WinBioAsyncEnumDatabases(DWORD FrameworkHandle, DWORD Factor)');
# my $ret = $WinBioAsyncEnumDatabases->Call($FrameworkHandle, $Factor);
# FrameworkHandle : DWORD -> DWORD
# Factor : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目