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

WinBioLockUnit

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

シグネチャ

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

HRESULT WinBioLockUnit(
    DWORD SessionHandle,
    DWORD UnitId
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

バイオメトリックユニットをロックし、単一のセッションによる排他的な使用を可能にします。Windows 10 ビルド 1607 以降、この関数はモバイルイメージでも使用できます。

戻り値

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

リターンコード 説明
E_HANDLE
セッションハンドルが無効です。
E_INVALIDARG
UnitId パラメーターに 0 を指定することはできません。
WINBIO_E_ENROLLMENT_IN_PROGRESS
指定されたバイオメトリックユニットが現在登録トランザクションに使用されているため、操作を完了できませんでした (システムプールのみ)。
WINBIO_E_LOCK_VIOLATION
指定されたセッションが既に別のユニットをロックしているため、このバイオメトリックユニットをロックできません。

解説(Remarks)

指定されたバイオメトリックユニットが別のセッションによってロックされている場合、WinBioLockUnit は、そのバイオメトリックユニットを所有するセッションがロックを解放するまで、呼び出し元のスレッドをブロックします。

保留中のロック要求を取り消し、セッションが保持しているすべてのロックを解放するには、WinBioUnlockUnit 関数を呼び出します。

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

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

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

例

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

HRESULT LockUnlock( )
{
    // 変数を宣言します。
    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;

    // システムプールに接続します。
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // サービスプロバイダー
            WINBIO_POOL_SYSTEM,         // プールの種類
            WINBIO_FLAG_DEFAULT,        // 構成とアクセス
            NULL,                       // バイオメトリックユニット ID の配列
            0,                          // バイオメトリックユニット ID の数
            NULL,                       // データベース ID
            &sessionHandle              // [out] セッションハンドル
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnumBiometricUnits failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // セッションをロックします。この例では、バイオメトリックユニット ID (1) を
    // ハードコードしています。
    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;


    // バイオメトリックセンサーを特定し、WINBIO_IDENTITY オブジェクトを取得します。
    // センサー上で指をスワイプする必要があります。
    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:

    // バイオメトリックユニットがロックされている場合は、ロックを解除します。
    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 WinBioLockUnit(
    DWORD SessionHandle,
    DWORD UnitId
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioLockUnit(
    uint SessionHandle,   // DWORD
    uint UnitId   // DWORD
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioLockUnit(
    SessionHandle As UInteger,   ' DWORD
    UnitId As UInteger   ' DWORD
) As Integer
End Function
' SessionHandle : DWORD
' UnitId : DWORD
Declare PtrSafe Function WinBioLockUnit 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

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

lib = Fiddle.dlopen('winbio.dll')
WinBioLockUnit = Fiddle::Function.new(
  lib['WinBioLockUnit'],
  [
    -Fiddle::TYPE_INT,  # SessionHandle : DWORD
    -Fiddle::TYPE_INT,  # UnitId : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winbio")]
extern "system" {
    fn WinBioLockUnit(
        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 WinBioLockUnit(uint SessionHandle, uint UnitId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winbio_WinBioLockUnit' -Namespace Win32 -PassThru
# $api::WinBioLockUnit(SessionHandle, UnitId)
#uselib "winbio.dll"
#func global WinBioLockUnit "WinBioLockUnit" sptr, sptr
; WinBioLockUnit SessionHandle, UnitId   ; 戻り値は stat
; SessionHandle : DWORD -> "sptr"
; UnitId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winbio.dll"
#cfunc global WinBioLockUnit "WinBioLockUnit" int, int
; res = WinBioLockUnit(SessionHandle, UnitId)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
; HRESULT WinBioLockUnit(DWORD SessionHandle, DWORD UnitId)
#uselib "winbio.dll"
#cfunc global WinBioLockUnit "WinBioLockUnit" int, int
; res = WinBioLockUnit(SessionHandle, UnitId)
; SessionHandle : DWORD -> "int"
; UnitId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioLockUnit = winbio.NewProc("WinBioLockUnit")
)

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

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

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

let winbiolockunit =
  foreign "WinBioLockUnit"
    (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 ("WinBioLockUnit" win-bio-lock-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 $WinBioLockUnit = Win32::API::More->new('winbio',
    'int WinBioLockUnit(DWORD SessionHandle, DWORD UnitId)');
# my $ret = $WinBioLockUnit->Call($SessionHandle, $UnitId);
# SessionHandle : DWORD -> DWORD
# UnitId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目