WINBIO_ASYNC_RESULT-Struktur (winbio.h)

Die WINBIO_ASYNC_RESULT-Struktur enthält die Ergebnisse eines asynchronen Vorgangs.

Syntax

typedef struct _WINBIO_ASYNC_RESULT {
  WINBIO_SESSION_HANDLE SessionHandle;
  WINBIO_OPERATION_TYPE Operation;
  ULONGLONG             SequenceNumber;
  LONGLONG              TimeStamp;
  HRESULT               ApiStatus;
  WINBIO_UNIT_ID        UnitId;
  PVOID                 UserData;
  union {
    struct {
      BOOLEAN              Match;
      WINBIO_REJECT_DETAIL RejectDetail;
    } Verify;
    struct {
      WINBIO_IDENTITY          Identity;
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
      WINBIO_REJECT_DETAIL     RejectDetail;
    } Identify;
    struct {
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
    } EnrollBegin;
    struct {
      WINBIO_REJECT_DETAIL RejectDetail;
    } EnrollCapture;
    struct {
      WINBIO_IDENTITY Identity;
      BOOLEAN         IsNewTemplate;
    } EnrollCommit;
    struct {
      WINBIO_IDENTITY          Identity;
      SIZE_T                   SubFactorCount;
      WINBIO_BIOMETRIC_SUBTYPE *SubFactorArray;
    } EnumEnrollments;
    struct {
      PWINBIO_BIR          Sample;
      SIZE_T               SampleSize;
      WINBIO_REJECT_DETAIL RejectDetail;
    } CaptureSample;
    struct {
      WINBIO_IDENTITY          Identity;
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
    } DeleteTemplate;
    struct {
      WINBIO_PROPERTY_TYPE     PropertyType;
      WINBIO_PROPERTY_ID       PropertyId;
      WINBIO_IDENTITY          Identity;
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
      SIZE_T                   PropertyBufferSize;
      PVOID                    PropertyBuffer;
    } GetProperty;
    struct {
      WINBIO_PROPERTY_TYPE     PropertyType;
      WINBIO_PROPERTY_ID       PropertyId;
      WINBIO_IDENTITY          Identity;
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
      SIZE_T                   PropertyBufferSize;
      PVOID                    PropertyBuffer;
    } SetProperty;
    struct {
      WINBIO_EVENT Event;
    } GetEvent;
    struct {
      WINBIO_COMPONENT Component;
      ULONG            ControlCode;
      ULONG            OperationStatus;
      PUCHAR           SendBuffer;
      SIZE_T           SendBufferSize;
      PUCHAR           ReceiveBuffer;
      SIZE_T           ReceiveBufferSize;
      SIZE_T           ReceiveDataSize;
    } ControlUnit;
    struct {
      SIZE_T            BspCount;
      WINBIO_BSP_SCHEMA *BspSchemaArray;
    } EnumServiceProviders;
    struct {
      SIZE_T             UnitCount;
      WINBIO_UNIT_SCHEMA *UnitSchemaArray;
    } EnumBiometricUnits;
    struct {
      SIZE_T                StorageCount;
      WINBIO_STORAGE_SCHEMA *StorageSchemaArray;
    } EnumDatabases;
    struct {
      BOOLEAN                  Match;
      WINBIO_REJECT_DETAIL     RejectDetail;
      WINBIO_PROTECTION_TICKET Ticket;
    } VerifyAndReleaseTicket;
    struct {
      WINBIO_IDENTITY          Identity;
      WINBIO_BIOMETRIC_SUBTYPE SubFactor;
      WINBIO_REJECT_DETAIL     RejectDetail;
      WINBIO_PROTECTION_TICKET Ticket;
    } IdentifyAndReleaseTicket;
    struct {
      ULONGLONG SelectorValue;
    } EnrollSelect;
    struct {
      WINBIO_PRESENCE_CHANGE ChangeType;
      SIZE_T                 PresenceCount;
      WINBIO_PRESENCE        *PresenceArray;
    } MonitorPresence;
    struct {
      WINBIO_IDENTITY          Identity;
      WINBIO_PROTECTION_POLICY Policy;
    } GetProtectionPolicy;
    struct {
      WINBIO_EXTENDED_UNIT_STATUS ExtendedStatus;
    } NotifyUnitStatusChange;
  } Parameters;
} WINBIO_ASYNC_RESULT, *PWINBIO_ASYNC_RESULT;

Member

SessionHandle

Handle einer asynchronen Sitzung, die durch Aufrufen der WinBioAsyncOpenSession-Funktion oder der WinBioAsyncOpenFramework-Funktion gestartet wird.

Operation

Typ des asynchronen Vorgangs. Weitere Informationen finden Sie unter WINBIO_OPERATION_TYPE Konstanten.

SequenceNumber

Sequenznummer des asynchronen Vorgangs. Die ganzen Zahlen werden für jeden Vorgang in einer biometrischen Sitzung sequenziell zugewiesen, beginnend bei 1 (1). Für jede Sitzung wird dem geöffneten Vorgang immer die erste Sequenznummer zugewiesen, und dem schließen-Vorgang wird die letzte Sequenznummer zugewiesen. Wenn Ihre Anwendung mehrere Vorgänge in die Warteschlange stellt, können Sie Sequenznummern verwenden, um fehlerbehandlung durchzuführen. Beispielsweise können Sie Vorgangsergebnisse ignorieren, bis eine bestimmte Sequenznummer an die Anwendung gesendet wird.

TimeStamp

Systemdatum und -uhrzeit, zu dem der biometrische Vorgang begonnen hat. Weitere Informationen finden Sie in der GetSystemTimeAsFileTime-Funktion .

ApiStatus

Fehlercode, der vom Vorgang zurückgegeben wird.

UnitId

Der numerische Einheitsbezeichner der biometrischen Einheit, die den Vorgang ausgeführt hat.

UserData

Adresse eines optionalen Puffers, der vom Aufrufer bereitgestellt wird. Der Puffer wird vom Framework oder der biometrischen Einheit nicht geändert. Ihre Anwendung kann die Daten verwenden, um zu bestimmen, welche Aktionen nach Erhalt der Abschlussbenachrichtigung ausgeführt werden sollen, oder um zusätzliche Informationen zum angeforderten Vorgang zu verwalten.

Parameters

Union, die geschachtelte Strukturen einschließt, die zusätzliche Informationen über den Erfolg oder Fehler von asynchronen Vorgängen enthalten, die von der Clientanwendung gestartet wurden.

Parameters.Verify

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioVerify.

Parameters.Verify.Match

Gibt an, ob das erfasste Beispiel mit der Benutzeridentität übereinstimmt.

Parameters.Verify.RejectDetail

Zusätzliche Informationen zum Überprüfungsfehler. Weitere Informationen finden Sie in den Hinweisen.

Parameters.Identify

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioIdentify.

Parameters.Identify.Identity

GUID oder SID des Benutzers, der die biometrische Stichprobe bereitstellt.

Parameters.Identify.SubFactor

Teilfaktor, der der biometrischen Stichprobe zugeordnet ist. Weitere Informationen finden Sie in den Hinweisen.

Parameters.Identify.RejectDetail

Zusätzliche Informationen zum Fehler, falls vorhanden, um eine biometrische Probe zu erfassen und zu identifizieren. Weitere Informationen finden Sie in den Hinweisen.

Parameters.EnrollBegin

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnrollBegin.

Parameters.EnrollBegin.SubFactor

Zusätzliche Informationen zur Registrierung. Weitere Informationen finden Sie in den Hinweisen.

Parameters.EnrollCapture

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnrollCapture.

Parameters.EnrollCapture.RejectDetail

Zusätzliche Informationen zum Fehler bei der Erfassung einer biometrischen Probe. Weitere Informationen finden Sie in den Hinweisen.

Parameters.EnrollCommit

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnrollCommit.

Parameters.EnrollCommit.Identity

GUID oder SID der zu speichernden Vorlage.

Parameters.EnrollCommit.IsNewTemplate

Gibt an, ob die Der Datenbank hinzugefügte Vorlage neu ist.

Parameters.EnumEnrollments

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnumEnrollments.

Parameters.EnumEnrollments.Identity

GUID oder SID der Vorlage, aus der die Unterfaktoren abgerufen wurden.

Parameters.EnumEnrollments.SubFactorCount

Anzahl der Elemente in dem Array, auf das vom SubFactorArray-Element verwiesen wird.

Parameters.EnumEnrollments.SubFactorArray

Zeiger auf ein Array von Unterfaktoren. Weitere Informationen finden Sie in den Hinweisen.

Parameters.CaptureSample

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioCaptureSample.

Parameters.CaptureSample.Sample

Zeiger auf eine WINBIO_BIR-Struktur , die das Beispiel enthält.

Parameters.CaptureSample.SampleSize

Größe der WINBIO_BIR Struktur, die im Beispielmember zurückgegeben wird, in Bytes.

Parameters.CaptureSample.RejectDetail

Zusätzliche Informationen zum Fehler bei der Erfassung einer biometrischen Probe. Weitere Informationen finden Sie in den Hinweisen.

Parameters.DeleteTemplate

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioDeleteTemplate.

Parameters.DeleteTemplate.Identity

GUID oder SID der gelöschten Vorlage.

Parameters.DeleteTemplate.SubFactor

Zusätzliche Informationen zur Vorlage.

Parameters.GetProperty

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioGetProperty.

Parameters.GetProperty.PropertyType

Quelle der Eigenschafteninformationen. Derzeit wird dies WINBIO_PROPERTY_TYPE_UNIT.

Parameters.GetProperty.PropertyId

Die abgefragte Eigenschaft. Derzeit wird dies WINBIO_PROPERTY_SAMPLE_HINT.

Parameters.GetProperty.Identity

Dies ist ein reservierter Wert und ist NULL.

Parameters.GetProperty.SubFactor

Dies ist reserviert und wird WINBIO_SUBTYPE_NO_INFORMATION.

Parameters.GetProperty.PropertyBufferSize

Größe des Eigenschaftswerts in Bytes, auf den das PropertyBuffer-Element verweist.

Parameters.GetProperty.PropertyBuffer

Zeiger auf den Eigenschaftswert.

Parameters.SetProperty

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioSetProperty. Dieses Element wird ab Windows 10 unterstützt.

SetProperty.PropretyBufferSize

Die Größe der Struktur in Bytes, auf die der PropertyBuffer-Parameter verweist.

Parameters.SetProperty.PropertyType

Ein WINBIO_PROPERTY_TYPE Wert, der den Typ der eigenschaft angibt, die festgelegt wurde. Dies kann derzeit nur WINBIO_PROPERTY_TYPE_ACCOUNT werden.

Parameters.SetProperty.PropertyId

Ein WINBIO_PROPERTY_ID Wert, der die festgelegte Eigenschaft angibt. Derzeit kann dieser Wert nur WINBIO_PROPERTY_ANTI_SPOOF_POLICY werden. Alle anderen Eigenschaften sind schreibgeschützt.

Parameters.SetProperty.Identity

Eine WINBIO_IDENTITY-Struktur , die das Konto angibt, für das die Eigenschaft festgelegt wurde.

Parameters.SetProperty.SubFactor

Reserviert. Derzeit wird dieser Wert immer WINBIO_SUBTYPE_NO_INFORMATION.

Parameters.SetProperty.PropertyBufferSize

Parameters.SetProperty.PropertyBuffer

Ein Zeiger auf eine Struktur, der den Wert angibt, auf den die Eigenschaft festgelegt wurde. Für die WINBIO_PROPERTY_ANTI_SPOOF_POLICY-Eigenschaft ist die Struktur eine WINBIO_ANTI_SPOOF_POLICY-Struktur .

Parameters.GetEvent

Enthält status Informationen zum ausgelösten Ereignis.

Parameters.GetEvent.Event

Enthält Ereignisinformationen.

Parameters.ControlUnit

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioControlUnit oder WinBioControlUnitPrivileged.

Parameters.ControlUnit.Component

Die Komponente innerhalb der biometrischen Einheit, die den Vorgang ausgeführt hat.

Parameters.ControlUnit.ControlCode

Vom Hersteller definierter Code, der von der biometrischen Einheit erkannt wird, die durch den UnitId-Parameter der WinBioControlUnit- oder WinBioControlUnitPrivileged-Funktion und den vom Component-Parameter angegebenen Adapter angegeben wird.

Parameters.ControlUnit.OperationStatus

Vom Hersteller definierte status Code, der das Ergebnis des Steuerungsvorgangs angibt.

Parameters.ControlUnit.SendBuffer

Zeiger auf einen Puffer, der die Steuerelementinformationen enthält, die von der Komponente an den Adapter gesendet werden. Das Format und der Inhalt des Puffers sind vom Anbieter definiert.

Parameters.ControlUnit.SendBufferSize

Größe des vom SendBuffer-Member angegebenen Puffers in Bytes.

Parameters.ControlUnit.ReceiveBuffer

Zeiger auf einen Puffer, der informationen empfängt, die vom Adapter gesendet werden, der vom Component-Element angegeben wird. Das Format und der Inhalt des Puffers sind vom Anbieter definiert.

Parameters.ControlUnit.ReceiveBufferSize

Größe des Puffers, der vom ReceiveBuffer-Member angegeben wird, in Bytes.

Parameters.ControlUnit.ReceiveDataSize

Größe der Daten in Bytes, die in den vom ReceiveBuffer-Element angegebenen Puffer geschrieben werden.

Parameters.EnumServiceProviders

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnumServiceProviders oder WinBioAsyncEnumServiceProviders.

Parameters.EnumServiceProviders.BspCount

Die Anzahl der Strukturen, auf die das BspSchemaArray-Element verweist.

Parameters.EnumServiceProviders.BspSchemaArray

Zeiger auf ein Array von WINBIO_BSP_SCHEMA Strukturen, die Informationen zu den einzelnen verfügbaren Dienstanbietern enthalten.

Parameters.EnumBiometricUnits

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnumBiometricUnits oder WinBioAsyncEnumBiometricUnits.

Parameters.EnumBiometricUnits.UnitCount

Anzahl der Strukturen, auf die das UnitSchemaArray-Element verweist.

Parameters.EnumBiometricUnits.UnitSchemaArray

Ein Array von WINBIO_UNIT_SCHEMA Strukturen, die Informationen zu jeder aufgezählten biometrischen Einheit enthalten.

Parameters.EnumDatabases

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnumDatabases oder WinBioAsyncEnumDatabases.

Parameters.EnumDatabases.StorageCount

Anzahl der Strukturen, auf die das StorageSchemaArray-Element verweist.

Parameters.EnumDatabases.StorageSchemaArray

Array von WINBIO_STORAGE_SCHEMA Strukturen, die Informationen zu jeder Datenbank enthalten.

Parameters.VerifyAndReleaseTicket

Reserviert. Dieser Member wird ab Windows 10 unterstützt.

Parameters.VerifyAndReleaseTicket.Match

Reserviert.

Parameters.VerifyAndReleaseTicket.RejectDetail

Reserviert.

Parameters.VerifyAndReleaseTicket.Ticket

Reserviert.

Parameters.IdentifyAndReleaseTicket

Reserviert. Dieser Member wird ab Windows 10 unterstützt.

Parameters.IdentifyAndReleaseTicket.Identity

Reserviert.

Parameters.IdentifyAndReleaseTicket.SubFactor

Reserviert.

Parameters.IdentifyAndReleaseTicket.RejectDetail

Reserviert.

Parameters.IdentifyAndReleaseTicket.Ticket

Reserviert.

Parameters.EnrollSelect

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioEnrollSelect. Dieser Member wird ab Windows 10 unterstützt.

Parameters.EnrollSelect.SelectorValue

Ein -Wert, der die Person identifiziert, die für die Registrierung ausgewählt wurde.

Parameters.MonitorPresence

Enthält die Ergebnisse eines asynchronen Aufrufs von WinBioMonitorPresence. Dieser Member wird ab Windows 10 unterstützt.

Parameters.MonitorPresence.ChangeType

Ein WINBIO_PRESENCE_CHANGE Wert, der den Typ des aufgetretenen Ereignisses angibt.

Parameters.MonitorPresence.PresenceCount

Die Größe des Arrays, auf das der MonitorPresence.PresenceArray-Member zeigt.

Parameters.MonitorPresence.PresenceArray

Adresse des Arrays von WINBIO_PRESENCE Strukturen, eine für jede überwachte Person.

Parameters.GetProtectionPolicy

Parameters.GetProtectionPolicy.Identity

Parameters.GetProtectionPolicy.Policy

Parameters.NotifyUnitStatusChange

Parameters.NotifyUnitStatusChange.ExtendedStatus

Hinweise

Asynchrone Vorgänge werden gestartet, indem eine biometrische Sitzung oder eine Frameworksitzung geöffnet wird. Rufen Sie WinBioAsyncOpenSession auf, um eine biometrische Sitzung zu öffnen. Rufen Sie WinBioAsyncOpenFramework auf, um eine Frameworksitzung zu öffnen.

Sie können ein asynchrones biometrisches Sitzungshandle verwenden, um jeden der folgenden Vorgänge asynchron aufzurufen:

• WinBioCancel
• WinBioCaptureSample
• WinBioCloseSession
• WinBioControlUnit
• WinBioControlUnitPrivileged
• WinBioDeleteTemplate
• WinBioEnrollBegin
• WinBioEnrollCapture
• WinBioEnrollCommit
• WinBioEnrollDiscard
• WinBioEnumEnrollments
• WinBioGetProperty
• WinBioIdentify
• WinBioLocateSensor
• WinBioLockUnit
• WinBioLogonIdentifiedUser
• WinBioRegisterEventMonitor
• WinBioUnlockUnit
• WinBioUnregisterEventMonitor
• WinBioVerify
• WinBioWait
• WinBioSetProperty
• WinBioEnrollSelect
• WinBioMonitorPresence

Sie können ein asynchrones Frameworkhandle verwenden, um die folgenden Vorgänge asynchron aufzurufen:

• WinBioAsyncEnumBiometricUnits
• WinBioAsyncEnumDatabases
• WinBioAsyncOpenFramework
• WinBioAsyncEnumServiceProviders
• WinBioAsyncMonitorFrameworkChanges

Die WINBIO_ASYNC_RESULT-Struktur wird intern vom Windows Biometric Framework zugeordnet. Wenn Sie es verwenden, rufen Sie daher WinBioFree auf, um den zugewiesenen Arbeitsspeicher freizugeben und Verluste zu vermeiden. Da dadurch auch alle geschachtelten Datenstrukturen freigegeben werden, sollten Sie keine Kopie von Zeigern beibehalten, die in der WINBIO_ASYNC_RESULT-Struktur zurückgegeben werden. Wenn Sie in einer geschachtelten Struktur zurückgegebene Daten speichern möchten, erstellen Sie eine private Kopie dieser Daten, bevor Sie WinBioFree aufrufen.

Windows 8, Windows Server 2012, Windows 8.1 und Windows Server 2012 R2: Das Windows Biometric Framework unterstützt nur Fingerabdruckleser. Wenn ein Vorgang fehlschlägt und zusätzliche Informationen in einer WINBIO_REJECT_DETAIL -Konstanten zurückgibt, handelt es sich daher um einen der folgenden Werte:

• WINBIO_FP_TOO_HIGH
• WINBIO_FP_TOO_LOW
• WINBIO_FP_TOO_LEFT
• WINBIO_FP_TOO_RIGHT
• WINBIO_FP_TOO_FAST
• WINBIO_FP_TOO_SLOW
• WINBIO_FP_POOR_QUALITY
• WINBIO_FP_TOO_SKEWED
• WINBIO_FP_TOO_SHORT
• WINBIO_FP_MERGE_FAILURE

Wenn ein Vorgang einen WINBIO_BIOMETRIC_SUBTYPE-Datentyp verwendet, handelt es sich um einen der folgenden Werte:

• WINBIO_ANSI_381_POS_UNKNOWN
• WINBIO_ANSI_381_POS_RH_THUMB
• WINBIO_ANSI_381_POS_RH_INDEX_FINGER
• WINBIO_ANSI_381_POS_RH_MIDDLE_FINGER
• WINBIO_ANSI_381_POS_RH_RING_FINGER
• WINBIO_ANSI_381_POS_RH_LITTLE_FINGER
• WINBIO_ANSI_381_POS_LH_THUMB
• WINBIO_ANSI_381_POS_LH_INDEX_FINGER
• WINBIO_ANSI_381_POS_LH_MIDDLE_FINGER
• WINBIO_ANSI_381_POS_LH_RING_FINGER
• WINBIO_ANSI_381_POS_LH_LITTLE_FINGER
• WINBIO_ANSI_381_POS_RH_FOUR_FINGERS
• WINBIO_ANSI_381_POS_LH_FOUR_FINGERS
• WINBIO_ANSI_381_POS_TWO_THUMBS

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Kopfzeile	winbio.h

Weitere Informationen

WINBIO_REJECT_DETAIL Konstanten

WinBioAsyncOpenFramework

WinBioAsyncOpenSession