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

WinBioUnlockUnit

関数
指定した生体認証ユニットのロックを解除する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioUnlockUnit(
    DWORD SessionHandle,
    DWORD UnitId
);

パラメーター

名前型方向説明
SessionHandleDWORDin開いているバイオメトリック セッションを識別する WINBIO_SESSION_HANDLE 値です。同期セッション ハンドルは WinBioOpenSession を呼び出して開きます。非同期セッション ハンドルは WinBioAsyncOpenSession を呼び出して開きます。
UnitIdDWORDinロックを解除するバイオメトリック ユニットを指定する WINBIO_UNIT_ID 値です。

戻り値の型: HRESULT

公式ドキュメント

指定されたバイオメトリック ユニットのセッション ロックを解放します。

戻り値

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

戻り値 説明
E_HANDLE
セッション ハンドルが有効ではありません。
E_INVALIDARG
UnitId パラメーターに 0 を指定することはできません。
WINBIO_E_LOCK_VIOLATION
UnitId パラメーターで指定されたバイオメトリック ユニットは、現在このセッションによってロックされていません。

解説(Remarks)

WinBioUnlockUnit を呼び出すと、そのセッションが保持しているロックが自動的に解放されます。UnitId で指定されたバイオメトリック ユニットが、事前に WinBioLockUnit 関数の呼び出しによってロックされていない場合、この関数は失敗します。

WinBioUnlockUnit を同期的に使用するには、WinBioOpenSession を呼び出して作成したセッション ハンドルを指定して、この関数を呼び出します。この関数は、操作が完了するかエラーが発生するまでブロックします。

WinBioUnlockUnit を非同期的に使用するには、WinBioAsyncOpenSession を呼び出して作成したセッション ハンドルを指定して、この関数を呼び出します。フレームワークは WINBIO_ASYNC_RESULT 構造体を割り当て、それを使用して操作の成功または失敗に関する情報を返します。WINBIO_ASYNC_RESULT 構造体は、WinBioAsyncOpenSession 関数の NotificationMethod パラメーターに設定した値に応じて、アプリケーションのコールバックまたはアプリケーションのメッセージ キューに返されます。

メモリ リークを防ぐため、使用が終わった WINBIO_ASYNC_RESULT 構造体は、WinBioFree を呼び出して解放する必要があります。

例

次の関数は、WinBioLockUnit を呼び出してバイオメトリック ユニットをロックしてから、WinBioIdentify を呼び出してユーザーを識別します。そして、開いているセッションを閉じる前に WinBioUnlockUnit を呼び出して、バイオメトリック ユニットのロックを解除します。Winbio.lib 静的ライブラリにリンクし、次のヘッダー ファイルをインクルードしてください。

HRESULT LockUnlock( )
{
    // Declare variables.
    HRESULT hr = S_OK;
    WINBIO_IDENTITY identity = {0};
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID unitId = 0;
    WINBIO_REJECT_DETAIL rejectDetail = 0;
    WINBIO_BIOMETRIC_SUBTYPE subFactor = WINBIO_SUBTYPE_NO_INFORMATION;
    BOOL lockAcquired = FALSE;

    // 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 WinBioEnumBiometricUnits failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Lock the session. The Biometric unit ID (1) is hard coded in
    // this example.
    hr = WinBioLockUnit( sessionHandle, 1 );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioLockUnit failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }
    wprintf_s(L"\n Biometric unit #1 is locked.\n");
    lockAcquired = TRUE;


    // Locate the biometric sensor and retrieve a WINBIO_IDENTITY object.
    // You must swipe your finger on the sensor.
    wprintf_s(L"\n Calling WinBioIdentify - Swipe finger on sensor...\n");
    hr = WinBioIdentify( 
            sessionHandle, 
            &unitId, 
            &identity, 
            &subFactor, 
            &rejectDetail
            );
    wprintf_s(L"\n Swipe processed - Unit ID: %d\n", unitId);
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioIdentify failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }


e_Exit:

    // Unlock the biometric unit if it is locked.
    if (lockAcquired == TRUE)
    {
        hr = WinBioUnlockUnit( sessionHandle, 1 );
        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioUnlockUnit failed. hr = 0x%x\n", hr);
        }
        wprintf_s(L"\n Biometric unit #1 is unlocked.\n");
        lockAcquired = FALSE;
    }

    if (sessionHandle != NULL)
    {
        WinBioCloseSession(sessionHandle);
        sessionHandle = NULL;
    }

    wprintf_s(L"\n Press 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 WinBioUnlockUnit(
    DWORD SessionHandle,
    DWORD UnitId
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioUnlockUnit(
    uint SessionHandle,   // DWORD
    uint UnitId   // DWORD
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioUnlockUnit(
    SessionHandle As UInteger,   ' DWORD
    UnitId As UInteger   ' DWORD
) As Integer
End Function
' SessionHandle : DWORD
' UnitId : DWORD
Declare PtrSafe Function WinBioUnlockUnit Lib "winbio" ( _
    ByVal SessionHandle As Long, _
    ByVal UnitId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinBioUnlockUnit = ctypes.windll.winbio.WinBioUnlockUnit
WinBioUnlockUnit.restype = ctypes.c_int
WinBioUnlockUnit.argtypes = [
    wintypes.DWORD,  # SessionHandle : DWORD
    wintypes.DWORD,  # UnitId : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioUnlockUnit = winbio.NewProc("WinBioUnlockUnit")
)

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

extern "winbio" fn WinBioUnlockUnit(
    SessionHandle: u32, // DWORD
    UnitId: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WinBioUnlockUnit(
    SessionHandle: uint32,  # DWORD
    UnitId: uint32  # DWORD
): int32 {.importc: "WinBioUnlockUnit", stdcall, dynlib: "winbio.dll".}
pragma(lib, "winbio");
extern(Windows)
int WinBioUnlockUnit(
    uint SessionHandle,   // DWORD
    uint UnitId   // DWORD
);
ccall((:WinBioUnlockUnit, "winbio.dll"), stdcall, Int32,
      (UInt32, UInt32),
      SessionHandle, UnitId)
# SessionHandle : DWORD -> UInt32
# UnitId : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinBioUnlockUnit(
    uint32_t SessionHandle,
    uint32_t UnitId);
]]
local winbio = ffi.load("winbio")
-- winbio.WinBioUnlockUnit(SessionHandle, UnitId)
-- SessionHandle : DWORD
-- UnitId : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winbio.dll');
const WinBioUnlockUnit = lib.func('__stdcall', 'WinBioUnlockUnit', 'int32_t', ['uint32_t', 'uint32_t']);
// WinBioUnlockUnit(SessionHandle, UnitId)
// SessionHandle : DWORD -> 'uint32_t'
// UnitId : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winbio.dll", {
  WinBioUnlockUnit: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.WinBioUnlockUnit(SessionHandle, UnitId)
// SessionHandle : DWORD -> "u32"
// UnitId : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinBioUnlockUnit(
    uint32_t SessionHandle,
    uint32_t UnitId);
C, "winbio.dll");
// $ffi->WinBioUnlockUnit(SessionHandle, UnitId);
// SessionHandle : DWORD
// UnitId : 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 WinBioUnlockUnit(
        int SessionHandle,   // DWORD
        int UnitId   // DWORD
    );
}
@[Link("winbio")]
lib Libwinbio
  fun WinBioUnlockUnit = WinBioUnlockUnit(
    SessionHandle : UInt32,   # DWORD
    UnitId : 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 WinBioUnlockUnitNative = Int32 Function(Uint32, Uint32);
typedef WinBioUnlockUnitDart = int Function(int, int);
final WinBioUnlockUnit = DynamicLibrary.open('winbio.dll')
    .lookupFunction<WinBioUnlockUnitNative, WinBioUnlockUnitDart>('WinBioUnlockUnit');
// SessionHandle : DWORD -> Uint32
// UnitId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinBioUnlockUnit(
  SessionHandle: DWORD;   // DWORD
  UnitId: DWORD   // DWORD
): Integer; stdcall;
  external 'winbio.dll' name 'WinBioUnlockUnit';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let winbiounlockunit =
  foreign "WinBioUnlockUnit"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* SessionHandle : DWORD -> uint32_t *)
(* UnitId : 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 ("WinBioUnlockUnit" win-bio-unlock-unit :convention :stdcall) :int32
  (session-handle :uint32)   ; DWORD
  (unit-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinBioUnlockUnit = Win32::API::More->new('winbio',
    'int WinBioUnlockUnit(DWORD SessionHandle, DWORD UnitId)');
# my $ret = $WinBioUnlockUnit->Call($SessionHandle, $UnitId);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目