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

WinBioLocateSensorWithCallback

関数
コールバック方式で対象の生体センサーを特定する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioLocateSensorWithCallback(
    DWORD SessionHandle,
    PWINBIO_LOCATE_SENSOR_CALLBACK LocateCallback,
    void* LocateCallbackContext   // optional
);

パラメーター

名前型方向説明
SessionHandleDWORDin開いているバイオメトリックセッションを識別する WINBIO_SESSION_HANDLE 値です。
LocateCallbackPWINBIO_LOCATE_SENSOR_CALLBACKinセンサーの位置特定が成功または失敗したときに WinBioLocateSensorWithCallback 関数から呼び出されるコールバック関数のアドレスです。このコールバック関数は自分で作成する必要があります。
LocateCallbackContextvoid*inoptionalコールバック関数の LocateCallbackContext パラメーターに渡される、アプリケーション定義のデータ構造体のアドレスです。この構造体には、カスタムコールバック関数が処理できるように設計された任意のデータを格納できます。

戻り値の型: HRESULT

公式ドキュメント

ユーザーが対話的に選択したバイオメトリックユニットの ID 番号を非同期に取得します。

戻り値

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

戻り値 説明
E_HANDLE
セッションハンドルが無効です。
E_POINTER
LocateCallback パラメーターで指定するアドレスを NULL にすることはできません。

解説(Remarks)

複数のセンサーを備えたシステムでは、この関数を使用して、ユーザーが登録に使用するセンサーとしてどれを選択したかを判別できます。この関数は識別情報を返しません。ユーザーによるセンサーの選択を示すためだけに提供されています。

SessionHandle パラメーターがシステムセンサープールを参照している場合、アプリケーションがウィンドウフォーカスを取得し、ユーザーがバイオメトリックサンプルを提供するまで、コールバック関数は呼び出されません。フォーカスを取得する方法は、作成するアプリケーションの種類によって異なります。たとえば、GUI アプリケーションを作成する場合は、WM_ACTIVATE、WM_SETFOCUS、またはその他の適切なメッセージを捕捉するメッセージハンドラーを実装できます。CUI アプリケーションを作成する場合は、GetConsoleWindow を呼び出してコンソールウィンドウのハンドルを取得し、そのハンドルを SetForegroundWindow 関数に渡して、コンソールウィンドウを強制的に前面に移動させ、フォーカスを割り当てます。アプリケーションがデタッチされたプロセスで実行されていてウィンドウを持たない場合や、Windows サービスである場合は、WinBioAcquireFocus と WinBioReleaseFocus を使用してフォーカスを手動で制御してください。

コールバックルーチンは次のシグネチャを持つ必要があります。


VOID CALLBACK LocateCallback(
__in_opt PVOID LocateCallbackContext,
__in HRESULT OperationStatus,
__in WINBIO_UNIT_ID UnitId
);

例

次の関数は WinBioLocateSensorWithCallback を呼び出してバイオメトリックセンサーの位置を特定します。 WinBioLocateSensorWithCallback は非同期関数であり、別のスレッドでセンサーを特定するように バイオメトリックサブシステムを構成します。バイオメトリックサブシステムからの出力は、 LocateSensorCallback という名前のカスタムコールバック関数に送られます。Winbio.lib スタティックライブラリをリンクし、次のヘッダーファイルをインクルードしてください。

HRESULT LocateSensorWithCallback(BOOL bCancel)
{
    HRESULT hr = S_OK;
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID unitId = 0;

    // Connect to the system pool. 
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // Service provider
            WINBIO_POOL_SYSTEM,         // Pool type
            WINBIO_FLAG_DEFAULT,        // Configuration and access
            NULL,                       // Array of biometric unit IDs
            0,                          // Count of biometric unit IDs
            NULL,                       // Database ID
            &sessionHandle              // [out] Session handle
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioOpenSession failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    wprintf_s(L"\n Calling WinBioLocateSensorWithCallback.");
    hr = WinBioLocateSensorWithCallback(
                sessionHandle,          // Open biometric session
                LocateSensorCallback,   // Callback function
                NULL                    // Optional context
                );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioLocateSensorWithCallback failed.");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }
    wprintf_s(L"\n Swipe the sensor ...\n");

    // Cancel the identification if the bCancel flag is set.
    if (bCancel)
    {
        wprintf_s(L"\n Starting CANCEL timer...\n");
        Sleep( 7000 );

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

    // Wait for the asynchronous identification process to complete 
    // or be canceled.
    hr = WinBioWait( sessionHandle );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioWait failed. hr = 0x%x\n", hr);
    }

e_Exit:

    if (sessionHandle != NULL)
    {
       wprintf_s(L"\n Closing the session.\n");

        hr = WinBioCloseSession(sessionHandle);
        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioCloseSession failed. hr = 0x%x\n", hr);
        }
        sessionHandle = NULL;
    }

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

    return hr;
}

//------------------------------------------------------------------------
// The following function is the callback for 
// WinBioLocateSensorWithCallback. The function filters the response 
// from the biometric subsystem and writes a result to the console window.
// 
VOID CALLBACK LocateSensorCallback(
    __in_opt PVOID LocateCallbackContext,
    __in HRESULT OperationStatus,
    __in WINBIO_UNIT_ID UnitId
    )
{
    UNREFERENCED_PARAMETER(LocateCallbackContext);

    wprintf_s(L"\n LocateSensorCallback executing.");

    // A sensor could not be located.
    if (FAILED(OperationStatus))
    {
        wprintf_s(L"\n LocateSensorCallback failed.");
        wprintf_s(L"OperationStatus = 0x%x\n", OperationStatus);
    }
    // A sensor was located.
    else
    {
        wprintf_s(L"\n Selected unit ID: %d\n", UnitId);
    }
}

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

各言語での呼び出し定義

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

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

WinBioLocateSensorWithCallback = ctypes.windll.winbio.WinBioLocateSensorWithCallback
WinBioLocateSensorWithCallback.restype = ctypes.c_int
WinBioLocateSensorWithCallback.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    ctypes.c_void_p,  # LocateCallback : PWINBIO_LOCATE_SENSOR_CALLBACK
    ctypes.POINTER(None),  # LocateCallbackContext : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioLocateSensorWithCallback = winbio.NewProc("WinBioLocateSensorWithCallback")
)

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

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

typedef WinBioLocateSensorWithCallbackNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef WinBioLocateSensorWithCallbackDart = int Function(int, Pointer<Void>, Pointer<Void>);
final WinBioLocateSensorWithCallback = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioLocateSensorWithCallbackNative, WinBioLocateSensorWithCallbackDart>('WinBioLocateSensorWithCallback');
// SessionHandle : DWORD -> Uint32
// LocateCallback : PWINBIO_LOCATE_SENSOR_CALLBACK -> Pointer<Void>
// LocateCallbackContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioLocateSensorWithCallback(
  SessionHandle: DWORD;   // DWORD
  LocateCallback: Pointer;   // PWINBIO_LOCATE_SENSOR_CALLBACK
  LocateCallbackContext: Pointer   // void* optional
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioLocateSensorWithCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinBioLocateSensorWithCallback"
  c_WinBioLocateSensorWithCallback :: Word32 -> Ptr () -> Ptr () -> IO Int32
-- SessionHandle : DWORD -> Word32
-- LocateCallback : PWINBIO_LOCATE_SENSOR_CALLBACK -> Ptr ()
-- LocateCallbackContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winbiolocatesensorwithcallback =
  foreign "WinBioLocateSensorWithCallback"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* LocateCallback : PWINBIO_LOCATE_SENSOR_CALLBACK -> (ptr void) *)
(* LocateCallbackContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winbio (t "winbio.dll"))
(cffi:use-foreign-library winbio)

(cffi:defcfun ("WinBioLocateSensorWithCallback" win-bio-locate-sensor-with-callback :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (locate-callback :pointer)   ; PWINBIO_LOCATE_SENSOR_CALLBACK
  (locate-callback-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioLocateSensorWithCallback = Win32::API::More->new('winbio',
    'int WinBioLocateSensorWithCallback(DWORD SessionHandle, LPVOID LocateCallback, LPVOID LocateCallbackContext)');
# my $ret = $WinBioLocateSensorWithCallback->Call($SessionHandle, $LocateCallback, $LocateCallbackContext);
# SessionHandle : DWORD -> DWORD
# LocateCallback : PWINBIO_LOCATE_SENSOR_CALLBACK -> LPVOID
# LocateCallbackContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

公式の関連項目
使用する型