Share via

WinBioGetEnrolledFactors-Funktion (winbio.h)

  • Artikel

Ruft Informationen zu den biometrischen Registrierungen ab, die der angegebene Benutzer auf dem Computer hat. Biometrische Registrierungen umfassen Registrierungen für Gesichtserkennung, Fingerabdrucküberprüfung, Irisüberprüfung usw.

Syntax

HRESULT WinBioGetEnrolledFactors(
  [in]  WINBIO_IDENTITY       *AccountOwner,
  [out] WINBIO_BIOMETRIC_TYPE *EnrolledFactors
);

Parameter

[in] AccountOwner

Eine WINBIO_IDENTITY Struktur für den Benutzer, dessen biometrische Registrierungen Sie erhalten möchten. Beispiel:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// For example, CopySid(...)

Um die Registrierungen für jeden Benutzer auf dem Computer anzuzeigen, geben Sie den WINBIO_ID_TYPE_WILDCARD Identitätstyp für die WINBIO_IDENTITY-Struktur an, die Sie für den AccountOwner-Parameter angeben. Beispiel:

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_WILDCARD;

[out] EnrolledFactors

Ein Satz von WINBIO_BIOMETRIC_TYPE Flags, die die biometrischen Registrierungen angeben, die der angegebene Benutzer auf dem Computer hat. Der Wert 0 gibt an, dass der Benutzer über keine biometrischen Registrierungen verfügt.

Diese Registrierungen stellen nur Systempoolregistrierungen dar, z. B. Registrierungen, mit denen Sie einen Benutzer für die Anmeldung, Entsperrung usw. authentifizieren können. Dieser Wert schließt keine Registrierungen für private Pools ein.

Wenn Sie den Identitätstyp für die WINBIO_IDENTITY angeben, die Sie für den AccountOwner-Parameter verwenden, stellt dieser Flagsatz den kombinierten Satz von Registrierungen für alle Benutzer mit Konten auf dem Computer dar.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird S_OK zurückgegeben. Wenn die Funktion fehlschlägt, wird ein HRESULT-Wert zurückgegeben, der den Fehler angibt. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle. Eine Liste allgemeiner Fehlercodes finden Sie unter Allgemeine HRESULT-Werte.

Rückgabecode Beschreibung
E_POINTER
 Die Parameter AccountOwner und EnrolledFactors können nicht NULL sein.
E_INVALIDARG
 Der Type-Member der WINBIO_IDENTITY-Struktur , die vom accountOnwer-Parameter angegeben wurde, war nicht WINBIO_ID_TYPE_SID oder WINBIO_ID_TYPE_WILDCARD, oder der AccountSid-Member der WINBIO_IDENTITY-Struktur war ungültig.

Hinweise

WinBioGetEnrolledFactors erfordert kein biometrisches Sitzungshandle und aktiviert den biometrischen Dienst nicht. Daher wird WinBioGetEnrolledFactors schnell ausgeführt und ist nützlich, wenn Ihr Code schnelle Entscheidungen über das Vorgehen treffen muss, wenn die Zeit für die auszuführenden Vorgänge entscheidend ist.

WinBioGetEnrolledFactors bietet Anmeldeinformationsanbietern eine Möglichkeit, ihre Benutzeroberfläche entsprechend anzupassen. Der Anmeldebildschirm ruft beispielsweise WinBioGetEnrolledFactors auf, um zu bestimmen, ob die Option zur Anmeldung mit einem Fingerabdruck angezeigt werden soll.

Beispiele

WINBIO_BIOMETRIC_TYPE enrolledFactors = WINBIO_NO_TYPE_AVAILABLE;

WINBIO_IDENTITY identity = {};
identity.Type = WINBIO_ID_TYPE_SID;

// Move an account SID into identity.Value.AccountSid.Data.
// e.g., CopySid(...)

HRESULT hr = WinBioGetEnrolledFactors(&identity, &enrolledFactors);

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 10 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2016 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile winbio.h
Bibliothek Winbio.lib
DLL Winbio.dll

Weitere Informationen

WINBIO_BIOMETRIC_TYPE

WINBIO_IDENTITY