ホーム › Devices.BiometricFramework › WINBIO_EXTENDED_ENROLLMENT_STATUS

WINBIO_EXTENDED_ENROLLMENT_STATUS

構造体

サイズx64: 32 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
TemplateStatus	HRESULT	4	+0	+0	登録テンプレートの作成状態を示すHRESULT。
RejectDetail	DWORD	4	+4	+4	サンプル拒否時の詳細理由コード。
PercentComplete	DWORD	4	+8	+8	登録の完了割合(パーセント)。
Factor	DWORD	4	+12	+12	登録対象の生体要素の種別を示す値。
SubFactor	BYTE	1	+16	+16	生体要素のサブタイプを示すバイト値。
Specific	_Specific_e__Union	8/4	+24	+20	生体要素種別に固有の登録状態情報を保持する無名共用体。

共用体: _Specific_e__Union x64 8B / x86 4B

フィールド	型	サイズ	x64	x86
Null	DWORD	4	+0	+0
FacialFeatures	_FacialFeatures_e__Struct	8/4	+0	+0
Fingerprint	_Fingerprint_e__Struct	8/4	+0	+0
Iris	_Iris_e__Struct	8/4	+0	+0
Voice	_Voice_e__Struct	8/4	+0	+0

公式ドキュメント

進行中の登録の状態に関する追加情報を格納します。

解説(Remarks)

TemplateStatus

登録テンプレートのサンプル収集の状態です。このメンバーには次の値が可能です。

値	意味
S_OK	登録を保存する準備ができています。
WINBIO_E_INVALID_OPERATION	進行中の登録はありません。
WINBIO_I_MORE_DATA	テンプレートを完成させるには、さらにサンプルが必要です。
WINBIO_E_BAD_CAPTURE	最新のサンプルは使用できません。

RejectDetail

TemplateStatus メンバーの値が WINBIO_E_BAD_CAPTURE の場合に、最新のサンプルが使用できない理由を示します。

PercentComplete

テンプレートのうち完成している割合に関する、エンジンアダプターによる最良の推定値です。0 から 100 の値で表されます。

Factor

この構造体にエンジンアダプターの機能および登録要件に関する情報が格納される対象の、生体認証ユニットの種類です。たとえば、Factor メンバーの値が WINBIO_TYPE_FINGERPRINT の場合、WINBIO_EXTENDED_ENGINE_INFO 構造体は指紋リーダーに適用され、関連する情報を Specifc.Fingerprint 構造体に格納します。

SubFactor

登録に関する追加情報を提供する WINBIO_BIOMETRIC_SUBTYPE 値です。

Specific

特定の生体認証要素について進行中の登録の状態に関する情報です。

Null

予約済みです。0 でなければなりません。

FacialFeatures

顔の特徴について進行中の登録の状態に関する情報です。

BoundingBox: 登録する個人の顔の、カメラフレーム内での位置 (ピクセル単位) です。この位置のピクセル数の上限は、カメラフレームのサイズによって決まります。カメラフレームのサイズを確認するには、WINBIO_PROPERTY_EXTENDED_SENSOR_INFO プロパティを取得します。プレゼンスモニターを使用するクライアントは、この位置をカメラフレームにマッピングするスケーリング処理を実行する必要があります。
Distance: 顔の実際の位置と、顔にとって理想的な焦点距離との差です。この値の範囲は -100 から 100 です。0 は理想的な距離を示し、正の値は顔の実際の位置が遠すぎることを、負の値は近すぎることを示します。

Fingerprint

指紋パターンについて進行中の登録の状態に関する情報です。

GeneralSamples: 新しい指紋テンプレートの作成に必要なサンプルの総数です。
Center: 新しい指紋テンプレートの作成に必要な、指紋の中央部分のサンプル数です。
TopEdge: 新しい指紋テンプレートの作成に必要な、指紋の上端部分のサンプル数です。
BottomEdge: 新しい指紋テンプレートの作成に必要な、指紋の下端部分のサンプル数です。
LeftEdge: 新しい指紋テンプレートの作成に必要な、指紋の左端部分のサンプル数です。
RightEdge: 新しい指紋テンプレートの作成に必要な、指紋の右端部分のサンプル数です。

Iris

虹彩パターンについて進行中の登録の状態に関する情報です。

EyeBoundingBox_1

登録する個人の一方の虹彩の、カメラフレーム内での位置 (ピクセル単位) です。虹彩認識システムが片方の目のみを監視している場合、この位置はその目の虹彩の位置です。虹彩認識システムが両目を監視していて、片方の目だけがカメラフレーム内にある場合、この位置はカメラフレーム内にある目の虹彩の位置です。虹彩認識システムが両目を監視していて、両目ともカメラフレーム内にある場合、この位置はおそらく個人の右目の虹彩の位置です。

この位置のピクセル数の上限は、カメラフレームのサイズによって決まります。カメラフレームのサイズを確認するには、WINBIO_PROPERTY_EXTENDED_SENSOR_INFO プロパティを取得します。プレゼンスモニターを使用するクライアントは、この位置をカメラフレームにマッピングするスケーリング処理を実行する必要があります。

EyeBoundingBox_2

登録する個人の一方の虹彩の、カメラフレーム内での位置 (ピクセル単位) です。虹彩認識システムが片方の目のみを監視している場合、またはカメラフレーム内に片方の目しかない場合、この値は空です。虹彩認識システムが両目を監視していて、両目ともカメラフレーム内にある場合、この位置はおそらく個人の左目の虹彩の位置です。

PupilCenter_1

登録する個人の一方の瞳孔の中心の位置です。虹彩認識システムが片方の目のみを監視している場合、この位置はその目の瞳孔の中心の位置です。虹彩認識システムが両目を監視していて、片方の目だけがカメラフレーム内にある場合、この位置はカメラフレーム内にある目の瞳孔の中心の位置です。虹彩認識システムが両目を監視していて、両目ともカメラフレーム内にある場合、この位置はおそらく個人の右目の瞳孔の中心の位置です。

PupilCenter_2

登録する個人の一方の瞳孔の中心の位置です。虹彩認識システムが片方の目のみを監視している場合、またはカメラフレーム内に片方の目しかない場合、この値は空です。虹彩認識システムが両目を監視していて、両目ともカメラフレーム内にある場合、この位置はおそらく個人の左目の瞳孔の中心の位置です。

Distance

虹彩の実際の位置と、虹彩にとって理想的な焦点距離との差です。この値の範囲は -100 から 100 です。0 は理想的な距離を示し、正の値は虹彩の実際の位置が遠すぎることを、負の値は近すぎることを示します。

Voice

音声パターンについて進行中の登録の状態に関する情報です。

Reserved: 予約済みです。

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

各言語での定義

#include <windows.h>

// WINBIO_EXTENDED_ENROLLMENT_STATUS  (x64 32 / x86 24 バイト)
typedef struct WINBIO_EXTENDED_ENROLLMENT_STATUS {
    HRESULT TemplateStatus;
    DWORD RejectDetail;
    DWORD PercentComplete;
    DWORD Factor;
    BYTE SubFactor;
    _Specific_e__Union Specific;
} WINBIO_EXTENDED_ENROLLMENT_STATUS;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WINBIO_EXTENDED_ENROLLMENT_STATUS
{
    public int TemplateStatus;
    public uint RejectDetail;
    public uint PercentComplete;
    public uint Factor;
    public byte SubFactor;
    public _Specific_e__Union Specific;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WINBIO_EXTENDED_ENROLLMENT_STATUS
    Public TemplateStatus As Integer
    Public RejectDetail As UInteger
    Public PercentComplete As UInteger
    Public Factor As UInteger
    Public SubFactor As Byte
    Public Specific As _Specific_e__Union
End Structure

import ctypes
from ctypes import wintypes

class WINBIO_EXTENDED_ENROLLMENT_STATUS(ctypes.Structure):
    _fields_ = [
        ("TemplateStatus", ctypes.c_int),
        ("RejectDetail", wintypes.DWORD),
        ("PercentComplete", wintypes.DWORD),
        ("Factor", wintypes.DWORD),
        ("SubFactor", ctypes.c_ubyte),
        ("Specific", _Specific_e__Union),
    ]

#[repr(C)]
pub struct WINBIO_EXTENDED_ENROLLMENT_STATUS {
    pub TemplateStatus: i32,
    pub RejectDetail: u32,
    pub PercentComplete: u32,
    pub Factor: u32,
    pub SubFactor: u8,
    pub Specific: _Specific_e__Union,
}

import "golang.org/x/sys/windows"

type WINBIO_EXTENDED_ENROLLMENT_STATUS struct {
	TemplateStatus int32
	RejectDetail uint32
	PercentComplete uint32
	Factor uint32
	SubFactor byte
	Specific _Specific_e__Union
}

type
  WINBIO_EXTENDED_ENROLLMENT_STATUS = record
    TemplateStatus: Integer;
    RejectDetail: DWORD;
    PercentComplete: DWORD;
    Factor: DWORD;
    SubFactor: Byte;
    Specific: _Specific_e__Union;
  end;

const WINBIO_EXTENDED_ENROLLMENT_STATUS = extern struct {
    TemplateStatus: i32,
    RejectDetail: u32,
    PercentComplete: u32,
    Factor: u32,
    SubFactor: u8,
    Specific: _Specific_e__Union,
};

type
  WINBIO_EXTENDED_ENROLLMENT_STATUS {.bycopy.} = object
    TemplateStatus: int32
    RejectDetail: uint32
    PercentComplete: uint32
    Factor: uint32
    SubFactor: uint8
    Specific: _Specific_e__Union

struct WINBIO_EXTENDED_ENROLLMENT_STATUS
{
    int TemplateStatus;
    uint RejectDetail;
    uint PercentComplete;
    uint Factor;
    ubyte SubFactor;
    _Specific_e__Union Specific;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WINBIO_EXTENDED_ENROLLMENT_STATUS サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; TemplateStatus : HRESULT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; RejectDetail : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; PercentComplete : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Factor : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; SubFactor : BYTE (+16, 1byte)  poke st,16,値  /  値 = peek(st,16)
; Specific : _Specific_e__Union (+20, 4byte)  varptr(st)+20 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WINBIO_EXTENDED_ENROLLMENT_STATUS サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; TemplateStatus : HRESULT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; RejectDetail : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; PercentComplete : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Factor : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; SubFactor : BYTE (+16, 1byte)  poke st,16,値  /  値 = peek(st,16)
; Specific : _Specific_e__Union (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WINBIO_EXTENDED_ENROLLMENT_STATUS
    #field int TemplateStatus
    #field int RejectDetail
    #field int PercentComplete
    #field int Factor
    #field byte SubFactor
    #field byte Specific 8
#endstruct

stdim st, WINBIO_EXTENDED_ENROLLMENT_STATUS        ; NSTRUCT 変数を確保
st->TemplateStatus = 100
mes "TemplateStatus=" + st->TemplateStatus
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。