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

WinBioEnrollDiscard

関数
進行中の生体情報登録を破棄する。
DLLwinbio.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WinBioEnrollDiscard(
    DWORD SessionHandle
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

登録シーケンスを終了し、保留中の生体認証テンプレートを破棄します。Windows 10 ビルド 1607 以降、この関数はモバイルイメージで使用できます。

戻り値

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

戻り値 説明
E_ACCESSDENIED
呼び出し元に登録を行う権限がありません。
E_HANDLE
セッションハンドルが無効です。
WINBIO_E_LOCK_VIOLATION
生体認証ユニットが使用中でロックされています。

解説(Remarks)

この関数を使用すると、生体認証テンプレートをテンプレートデータベースに保存する前に、ユーザーが登録シーケンスを中止できるようにすることができます。

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

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

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

例

次の関数は、生体認証テンプレートをシステムプールに登録します。この関数にはブール値を渡すことができ、WinBioEnrollDiscard を呼び出して登録を破棄できます。Winbio.lib 静的ライブラリをリンクし、次のヘッダーファイルをインクルードしてください。

HRESULT EnrollSysPool(
                      BOOL discardEnrollment, 
                      WINBIO_BIOMETRIC_SUBTYPE subFactor)
{
    HRESULT hr = S_OK;
    WINBIO_IDENTITY identity = {0};
    WINBIO_SESSION_HANDLE sessionHandle = NULL;
    WINBIO_UNIT_ID unitId = 0;
    WINBIO_REJECT_DETAIL rejectDetail = 0;
    BOOLEAN isNewTemplate = TRUE;

    // システムプールに接続します。
    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 WinBioOpenSession failed. ");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // センサーを検索します。
    wprintf_s(L"\n Swipe your finger on the sensor...\n");
    hr = WinBioLocateSensor( sessionHandle, &unitId);
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioLocateSensor failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // 登録シーケンスを開始します。
    wprintf_s(L"\n Starting enrollment sequence...\n");
    hr = WinBioEnrollBegin(
            sessionHandle,      // オープン済みの生体認証セッションのハンドル
            subFactor,          // テンプレートを作成する指
            unitId              // 生体認証ユニット ID
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnrollBegin failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // WinBioEnrollBegin 関数の subFactor 引数で指定した指で
    // センサーをスワイプし、登録情報をキャプチャします。
    for (int swipeCount = 1;; ++swipeCount)
    {
        wprintf_s(L"\n Swipe the sensor to capture %s sample.",
                 (swipeCount == 1)?L"the first":L"another");

        hr = WinBioEnrollCapture(
                sessionHandle,  // オープン済みの生体認証セッションのハンドル
                &rejectDetail   // [out] 失敗情報
                );

        wprintf_s(L"\n Sample %d captured from unit number %d.", 
                  swipeCount, 
                  unitId);

        if (hr == WINBIO_I_MORE_DATA)
        {
            wprintf_s(L"\n    More data required.\n");
            continue;
        }
        if (FAILED(hr))
        {
            if (hr == WINBIO_E_BAD_CAPTURE)
            {
                wprintf_s(L"\n  Error: Bad capture; reason: %d", 
                          rejectDetail);
                continue;
            }
            else
            {
                wprintf_s(L"\n WinBioEnrollCapture failed. hr = 0x%x", hr);
                goto e_Exit;
            }
        }
        else
        {
            wprintf_s(L"\n    Template completed.\n");
            break;
        }
    }

    // 該当するフラグが設定されている場合は登録を破棄します。
    // 破棄しない場合は登録をコミットします。
    if (discardEnrollment == TRUE)
    {
        wprintf_s(L"\n Discarding enrollment...\n\n");
        hr = WinBioEnrollDiscard( sessionHandle );
        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioLocateSensor failed. hr = 0x%x\n", hr);
        }
        goto e_Exit;    
    }
    else
    {
        wprintf_s(L"\n Committing enrollment...\n");
        hr = WinBioEnrollCommit( 
                sessionHandle,      // オープン済みの生体認証セッションのハンドル
                &identity,          // ユーザーの WINBIO_IDENTITY オブジェクト
                &isNewTemplate);    // 新しいテンプレートかどうか

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


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

    wprintf_s(L" Press any key to continue...");
    _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 WinBioEnrollDiscard(
    DWORD SessionHandle
);
[DllImport("winbio.dll", ExactSpelling = true)]
static extern int WinBioEnrollDiscard(
    uint SessionHandle   // DWORD
);
<DllImport("winbio.dll", ExactSpelling:=True)>
Public Shared Function WinBioEnrollDiscard(
    SessionHandle As UInteger   ' DWORD
) As Integer
End Function
' SessionHandle : DWORD
Declare PtrSafe Function WinBioEnrollDiscard 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

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

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

var (
	winbio = windows.NewLazySystemDLL("winbio.dll")
	procWinBioEnrollDiscard = winbio.NewProc("WinBioEnrollDiscard")
)

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

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

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

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

関連項目

公式の関連項目