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

WinBioCancel

関数
実行中の生体認証操作をキャンセルする。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioCancel(
    DWORD SessionHandle
);

パラメーター

名前型方向説明
SessionHandleDWORDin開いている生体認証セッションを識別する WINBIO_SESSION_HANDLE 値。同期セッションハンドルは WinBioOpenSession を呼び出して開きます。非同期セッションハンドルは WinBioAsyncOpenSession を呼び出して開きます。

戻り値の型: HRESULT

公式ドキュメント

指定したセッションの保留中の生体認証操作をすべてキャンセルします。Windows 10 ビルド 1607 以降、この関数はモバイルイメージでも使用できます。

戻り値

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

戻り値 説明
E_HANDLE
セッションハンドルが無効です。

解説(Remarks)

WinBioCancel を同期的に使用するには、WinBioOpenSession を呼び出して作成したセッションハンドルを指定してこの関数を呼び出します。同期セッションハンドルを使用してこの関数を呼び出した場合は次のとおりです。

WinBioCancel を非同期的に使用するには、WinBioAsyncOpenSession を呼び出して作成したセッションハンドルを指定してこの関数を呼び出します。非同期セッションハンドルを使用してこの関数を呼び出した場合は次のとおりです。 また、フレームワークは WinBioCancel 用に WINBIO_ASYNC_RESULT 構造体を割り当て、キャンセルの成否に関する情報を返すために使用します。WINBIO_ASYNC_RESULT 構造体は、WinBioAsyncOpenSession 関数の NotificationMethod パラメーターに設定した値に応じて、アプリケーションのコールバックまたはアプリケーションのメッセージキューに返されます。 メモリリークを防ぐため、WINBIO_ASYNC_RESULT 構造体の使用を終えたら、WinBioFree を呼び出して解放する必要があります。

例

次のコード例は、WinBioCaptureSampleWithCallback を呼び出してサンプルを非同期に取得します。この関数には Boolean 値を渡すことができ、TRUE を指定すると取得操作をキャンセルします。Winbio.lib スタティックライブラリにリンクし、次のヘッダーファイルをインクルードしてください。

HRESULT CaptureSampleWithCallback(BOOL bCancel)
{
    HRESULT hr = S_OK;
    WINBIO_SESSION_HANDLE sessionHandle = NULL;

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

    // 生体認証サンプルを非同期に取得します。
    wprintf_s(L"\n Calling WinBioCaptureSampleWithCallback ");
    hr = WinBioCaptureSampleWithCallback(
            sessionHandle,                  // 開いているセッションハンドル
            WINBIO_NO_PURPOSE_AVAILABLE,    // サンプルの用途
            WINBIO_DATA_FLAG_RAW,           // サンプルの形式
            CaptureSampleCallback,          // コールバック関数
            NULL                            // 省略可能なコンテキスト
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioCaptureSampleWithCallback failed. ");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }
    wprintf_s(L"\n Swipe the sensor ...\n");

    // bCancel フラグが設定されている場合は取得操作をキャンセルします。
    if (bCancel)
    {
        wprintf_s(L"\n Starting CANCEL timer...");
        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;
        }
    }

    // 非同期の取得処理が完了するか
    // キャンセルされるまで待機します。
    hr = WinBioWait( sessionHandle );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioWait failed. hr = 0x%x\n", hr);
    }

e_Exit:

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

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

    return hr;
}

//------------------------------------------------------------------------
// 次の関数は WinBioCaptureSampleWithCallback 用のコールバックです。
// この関数は生体認証サブシステムからの応答を選別し、
// 結果をコンソールウィンドウに出力します。
//
VOID CALLBACK CaptureSampleCallback(
    __in_opt PVOID CaptureCallbackContext,
    __in HRESULT OperationStatus,
    __in WINBIO_UNIT_ID UnitId,
    __in_bcount(SampleSize) PWINBIO_BIR Sample,
    __in SIZE_T SampleSize,
    __in WINBIO_REJECT_DETAIL RejectDetail
    )
{
    UNREFERENCED_PARAMETER(CaptureCallbackContext);

    wprintf_s(L"\n CaptureSampleCallback executing");
    wprintf_s(L"\n Swipe processed - Unit ID: %d", UnitId);

    if (FAILED(OperationStatus))
    {
        if (OperationStatus == WINBIO_E_BAD_CAPTURE)
        {
            wprintf_s(L"\n Bad capture; reason: %d\n", RejectDetail);
         }
        else
        {
            wprintf_s(L"\n WinBioCaptureSampleWithCallback failed. ");
            wprintf_s(L" OperationStatus = 0x%x\n", OperationStatus);
        }
        goto e_Exit;
    }

    wprintf_s(L"\n Captured %d bytes.\n", SampleSize);

e_Exit:

    if (Sample != NULL)
    {
        WinBioFree(Sample);
        Sample = NULL;
    }
}

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

各言語での呼び出し定義

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

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

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

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioCancel = winbio.NewProc("WinBioCancel")
)

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

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

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

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