Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
FactorDWORDin列挙対象の生体認証ファクターを表すフラグ。WINBIO_TYPE値の組み合わせ。
StorageSchemaArrayWINBIO_STORAGE_SCHEMA**out登録済みデータベース情報の配列を受け取る出力ポインタ。要WinBioFreeで解放。
StorageCountUINT_PTR*out返された配列の要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT WinBioEnumDatabases(DWORD Factor, WINBIO_STORAGE_SCHEMA** StorageSchemaArray, UINT_PTR* StorageCount)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioEnumDatabases = winbio.NewProc("WinBioEnumDatabases")
)

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

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

typedef WinBioEnumDatabasesNative = Int32 Function(Uint32, Pointer<Void>, Pointer<UintPtr>);
typedef WinBioEnumDatabasesDart = int Function(int, Pointer<Void>, Pointer<UintPtr>);
final WinBioEnumDatabases = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioEnumDatabasesNative, WinBioEnumDatabasesDart>('WinBioEnumDatabases');
// Factor : DWORD -> Uint32
// StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out -> Pointer<Void>
// StorageCount : UINT_PTR* out -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioEnumDatabases(
  Factor: DWORD;   // DWORD
  StorageSchemaArray: Pointer;   // WINBIO_STORAGE_SCHEMA** out
  StorageCount: Pointer   // UINT_PTR* out
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioEnumDatabases';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioEnumDatabases"
  c_WinBioEnumDatabases :: Word32 -> Ptr () -> Ptr CUIntPtr -> IO Int32
-- Factor : DWORD -> Word32
-- StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out -> Ptr ()
-- StorageCount : UINT_PTR* out -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbioenumdatabases =
  foreign "WinBioEnumDatabases"
    (uint32_t @-> (ptr void) @-> (ptr size_t) @-> returning int32_t)
(* Factor : DWORD -> uint32_t *)
(* StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out -> (ptr void) *)
(* StorageCount : UINT_PTR* 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 ("WinBioEnumDatabases" win-bio-enum-databases :convention :stdcall) :int32
  (factor :uint32)   ; DWORD
  (storage-schema-array :pointer)   ; WINBIO_STORAGE_SCHEMA** out
  (storage-count :pointer))   ; UINT_PTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioEnumDatabases = Win32::API::More->new('winbio',
    'int WinBioEnumDatabases(DWORD Factor, LPVOID StorageSchemaArray, LPVOID StorageCount)');
# my $ret = $WinBioEnumDatabases->Call($Factor, $StorageSchemaArray, $StorageCount);
# Factor : DWORD -> DWORD
# StorageSchemaArray : WINBIO_STORAGE_SCHEMA** out -> LPVOID
# StorageCount : UINT_PTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型