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

WINBIO_PRESENCE

構造体
サイズx64: 168 バイト / x86: 160 バイト

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

フィールド

フィールドサイズx64x86説明
FactorDWORD4+0+0検出された生体要素の種別(指紋・顔等)を示す値。
SubFactorBYTE1+4+4生体要素のサブタイプを示すバイト値。
StatusHRESULT4+8+8この対象の検出処理結果を示すHRESULT。
RejectDetailDWORD4+12+12拒否時の詳細理由コード。
IdentityWINBIO_IDENTITY40/36+16+16検出された対象の識別情報(WINBIO_IDENTITY)。
TrackingIdULONGLONG8+56+56追跡対象を一意に識別する追跡ID(64ビット)。
TicketULONGLONG8+64+64対象に関連付けられたチケット値(64ビット)。
PropertiesWINBIO_PRESENCE_PROPERTIES56/52+72+72顔・虹彩等の検出特徴を保持するWINBIO_PRESENCE_PROPERTIES。
Authorization_Authorization_e__Struct36+128+124認可情報を保持する内部構造体。

構造体: _Authorization_e__Struct x64 36B / x86 36B

フィールドサイズx64x86
SizeDWORD4+0+0
DataBYTE32+4+4

公式ドキュメント

存在が監視されている個人の存在に関する情報を格納します。

解説(Remarks)

EngineAdapterIdentifyAll 関数は WINBIO_PRESENCE 構造体の配列を作成し、この配列を生体認証サービスに送信します。生体認証サービスはこの配列を使用して、コンピューターの近くにいる人物の内部モデルを更新します。

この更新の結果に応じて、生体認証サービスは、アクティブな存在モニターを持つクライアントに対して、WinBioMonitorPresence 関数用の WINBIO_ASYNC_RESULT 構造体を生成することがあります。この構造体の WINBIO_ASYNC_RESULT.Operation メンバーには WINBIO_OPERATION_MONITOR_PRESENCE が格納され、WINBIO_ASYNC_RESULT.Parameters.MonitorPresence.ChangeType メンバーが個人の状態に関する追加情報を提供します。

エンジン アダプターが特定の追跡識別子に関連付けている個人が初めて入力ストリームに現れると、生体認証サービスは、WINBIO_ASYNC_RESULT.Parameters.MonitorPresence.ChangeType メンバーが WINBIO_CHANGE_TYPE_ARRIVAL であるクライアント側の WINBIO_ASYNC_RESULT 構造体を生成します。この構造体は、WINBIO_ASYNC_RESULT.Parameters.MonitorPresence.PresenceArrayWINBIO_PRESENCE.TrackingId が同じ値の WINBIO_PRESENCE 構造体を含む他のどの WINBIO_ASYNC_RESULT 構造体よりも先に、アプリケーションのコールバック関数またはアプリケーションのメッセージ キューに送信されます。

WINBIO_ASYNC_RESULT.Parameters.MonitorPresence.PresenceArray メンバーに含まれる WINBIO_PRESENCE 構造体の配列における次の値の組み合わせは、個人の状態に関する特定の種類の変化を示します。

エンジン アダプターが特定の追跡識別子に関連付けている個人がカメラ フレームから離れ、EngineAdapterIdentifyAll 関数が返す値に現れなくなると、その追跡識別子はやがて期限切れになります。追跡識別子が期限切れになると、生体認証サービスは、WINBIO_ASYNC_RESULT.Parameters.MonitorPresence.ChangeType メンバーが WINBIO_CHANGE_TYPE_DEPART であるクライアント側の WINBIO_ASYNC_RESULT 構造体を生成します。エンジン アダプターは、この「解説」で前述したように、WINBIO_PRESENCE.Status メンバーが S_OKWINBIO_PRESENCE.Identity.Type メンバーが WINBIO_ID_TYPE_NULL である WINBIO_PRESENCE 構造体を EngineAdapterIdentifyAll が返す配列に含めることによって、生体認証サービスが WINBIO_CHANGE_TYPE_DEPART 値を持つこの構造体を生成しないようにすることができます。この操作により、クライアント側のアクティビティを発生させることなく、追跡識別子の有効期限が延長されます。

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

各言語での定義

#include <windows.h>

// WINBIO_IDENTITY  (x64 40 / x86 36 バイト)
typedef struct WINBIO_IDENTITY {
    DWORD Type;
    _Value_e__Union Value;
} WINBIO_IDENTITY;

// WINBIO_PRESENCE_PROPERTIES  (x64 56 / x86 52 バイト)
typedef struct WINBIO_PRESENCE_PROPERTIES {
    _FacialFeatures_e__Struct FacialFeatures;
    _Iris_e__Struct Iris;
} WINBIO_PRESENCE_PROPERTIES;

// WINBIO_PRESENCE  (x64 168 / x86 160 バイト)
typedef struct WINBIO_PRESENCE {
    DWORD Factor;
    BYTE SubFactor;
    HRESULT Status;
    DWORD RejectDetail;
    WINBIO_IDENTITY Identity;
    ULONGLONG TrackingId;
    ULONGLONG Ticket;
    WINBIO_PRESENCE_PROPERTIES Properties;
    _Authorization_e__Struct Authorization;
} WINBIO_PRESENCE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WINBIO_IDENTITY
{
    public uint Type;
    public _Value_e__Union Value;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WINBIO_PRESENCE_PROPERTIES
{
    public _FacialFeatures_e__Struct FacialFeatures;
    public _Iris_e__Struct Iris;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WINBIO_PRESENCE
{
    public uint Factor;
    public byte SubFactor;
    public int Status;
    public uint RejectDetail;
    public WINBIO_IDENTITY Identity;
    public ulong TrackingId;
    public ulong Ticket;
    public WINBIO_PRESENCE_PROPERTIES Properties;
    public _Authorization_e__Struct Authorization;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WINBIO_IDENTITY
    Public Type As UInteger
    Public Value As _Value_e__Union
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WINBIO_PRESENCE_PROPERTIES
    Public FacialFeatures As _FacialFeatures_e__Struct
    Public Iris As _Iris_e__Struct
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WINBIO_PRESENCE
    Public Factor As UInteger
    Public SubFactor As Byte
    Public Status As Integer
    Public RejectDetail As UInteger
    Public Identity As WINBIO_IDENTITY
    Public TrackingId As ULong
    Public Ticket As ULong
    Public Properties As WINBIO_PRESENCE_PROPERTIES
    Public Authorization As _Authorization_e__Struct
End Structure
import ctypes
from ctypes import wintypes

class WINBIO_IDENTITY(ctypes.Structure):
    _fields_ = [
        ("Type", wintypes.DWORD),
        ("Value", _Value_e__Union),
    ]

class WINBIO_PRESENCE_PROPERTIES(ctypes.Structure):
    _fields_ = [
        ("FacialFeatures", _FacialFeatures_e__Struct),
        ("Iris", _Iris_e__Struct),
    ]

class WINBIO_PRESENCE(ctypes.Structure):
    _fields_ = [
        ("Factor", wintypes.DWORD),
        ("SubFactor", ctypes.c_ubyte),
        ("Status", ctypes.c_int),
        ("RejectDetail", wintypes.DWORD),
        ("Identity", WINBIO_IDENTITY),
        ("TrackingId", ctypes.c_ulonglong),
        ("Ticket", ctypes.c_ulonglong),
        ("Properties", WINBIO_PRESENCE_PROPERTIES),
        ("Authorization", _Authorization_e__Struct),
    ]
#[repr(C)]
pub struct WINBIO_IDENTITY {
    pub Type: u32,
    pub Value: _Value_e__Union,
}

#[repr(C)]
pub struct WINBIO_PRESENCE_PROPERTIES {
    pub FacialFeatures: _FacialFeatures_e__Struct,
    pub Iris: _Iris_e__Struct,
}

#[repr(C)]
pub struct WINBIO_PRESENCE {
    pub Factor: u32,
    pub SubFactor: u8,
    pub Status: i32,
    pub RejectDetail: u32,
    pub Identity: WINBIO_IDENTITY,
    pub TrackingId: u64,
    pub Ticket: u64,
    pub Properties: WINBIO_PRESENCE_PROPERTIES,
    pub Authorization: _Authorization_e__Struct,
}
import "golang.org/x/sys/windows"

type WINBIO_IDENTITY struct {
	Type uint32
	Value _Value_e__Union
}

type WINBIO_PRESENCE_PROPERTIES struct {
	FacialFeatures _FacialFeatures_e__Struct
	Iris _Iris_e__Struct
}

type WINBIO_PRESENCE struct {
	Factor uint32
	SubFactor byte
	Status int32
	RejectDetail uint32
	Identity WINBIO_IDENTITY
	TrackingId uint64
	Ticket uint64
	Properties WINBIO_PRESENCE_PROPERTIES
	Authorization _Authorization_e__Struct
}
type
  WINBIO_IDENTITY = record
    Type: DWORD;
    Value: _Value_e__Union;
  end;

  WINBIO_PRESENCE_PROPERTIES = record
    FacialFeatures: _FacialFeatures_e__Struct;
    Iris: _Iris_e__Struct;
  end;

  WINBIO_PRESENCE = record
    Factor: DWORD;
    SubFactor: Byte;
    Status: Integer;
    RejectDetail: DWORD;
    Identity: WINBIO_IDENTITY;
    TrackingId: UInt64;
    Ticket: UInt64;
    Properties: WINBIO_PRESENCE_PROPERTIES;
    Authorization: _Authorization_e__Struct;
  end;
const WINBIO_IDENTITY = extern struct {
    Type: u32,
    Value: _Value_e__Union,
};

const WINBIO_PRESENCE_PROPERTIES = extern struct {
    FacialFeatures: _FacialFeatures_e__Struct,
    Iris: _Iris_e__Struct,
};

const WINBIO_PRESENCE = extern struct {
    Factor: u32,
    SubFactor: u8,
    Status: i32,
    RejectDetail: u32,
    Identity: WINBIO_IDENTITY,
    TrackingId: u64,
    Ticket: u64,
    Properties: WINBIO_PRESENCE_PROPERTIES,
    Authorization: _Authorization_e__Struct,
};
type
  WINBIO_IDENTITY {.bycopy.} = object
    Type: uint32
    Value: _Value_e__Union

  WINBIO_PRESENCE_PROPERTIES {.bycopy.} = object
    FacialFeatures: _FacialFeatures_e__Struct
    Iris: _Iris_e__Struct

  WINBIO_PRESENCE {.bycopy.} = object
    Factor: uint32
    SubFactor: uint8
    Status: int32
    RejectDetail: uint32
    Identity: WINBIO_IDENTITY
    TrackingId: uint64
    Ticket: uint64
    Properties: WINBIO_PRESENCE_PROPERTIES
    Authorization: _Authorization_e__Struct
struct WINBIO_IDENTITY
{
    uint Type;
    _Value_e__Union Value;
}

struct WINBIO_PRESENCE_PROPERTIES
{
    _FacialFeatures_e__Struct FacialFeatures;
    _Iris_e__Struct Iris;
}

struct WINBIO_PRESENCE
{
    uint Factor;
    ubyte SubFactor;
    int Status;
    uint RejectDetail;
    WINBIO_IDENTITY Identity;
    ulong TrackingId;
    ulong Ticket;
    WINBIO_PRESENCE_PROPERTIES Properties;
    _Authorization_e__Struct Authorization;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WINBIO_PRESENCE サイズ: 160 バイト(x86)
dim st, 40    ; 4byte整数×40(構造体サイズ 160 / 4 切り上げ)
; Factor : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; SubFactor : BYTE (+4, 1byte)  poke st,4,値  /  値 = peek(st,4)
; Status : HRESULT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; RejectDetail : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; Identity : WINBIO_IDENTITY (+16, 36byte)  varptr(st)+16 を基点に操作(36byte:入れ子/配列)
; TrackingId : ULONGLONG (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; Ticket : ULONGLONG (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; Properties : WINBIO_PRESENCE_PROPERTIES (+72, 52byte)  varptr(st)+72 を基点に操作(52byte:入れ子/配列)
; Authorization : _Authorization_e__Struct (+124, 36byte)  varptr(st)+124 を基点に操作(36byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WINBIO_PRESENCE サイズ: 168 バイト(x64)
dim st, 42    ; 4byte整数×42(構造体サイズ 168 / 4 切り上げ)
; Factor : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; SubFactor : BYTE (+4, 1byte)  poke st,4,値  /  値 = peek(st,4)
; Status : HRESULT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; RejectDetail : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; Identity : WINBIO_IDENTITY (+16, 40byte)  varptr(st)+16 を基点に操作(40byte:入れ子/配列)
; TrackingId : ULONGLONG (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; Ticket : ULONGLONG (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; Properties : WINBIO_PRESENCE_PROPERTIES (+72, 56byte)  varptr(st)+72 を基点に操作(56byte:入れ子/配列)
; Authorization : _Authorization_e__Struct (+128, 36byte)  varptr(st)+128 を基点に操作(36byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global WINBIO_IDENTITY
    #field int Type
    #field byte Value 32
#endstruct

#defstruct global WINBIO_PRESENCE
    #field int Factor
    #field byte SubFactor
    #field int Status
    #field int RejectDetail
    #field WINBIO_IDENTITY Identity
    #field int64 TrackingId
    #field int64 Ticket
    #field byte Properties 56
    #field _Authorization_e__Struct Authorization
#endstruct

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