WinBioSetProperty-Funktion (winbio.h)

Artikel
08/27/2023

Legt den Wert einer Standardeigenschaft fest, die einer biometrischen Sitzung, Einheit, Vorlage oder einem Konto zugeordnet ist. Ab Windows 10 Build 1607 ist diese Funktion für die Verwendung mit einem mobilen Image verfügbar.

Syntax

HRESULT WinBioSetProperty(
  [in]           WINBIO_SESSION_HANDLE    SessionHandle,
  [in]           WINBIO_PROPERTY_TYPE     PropertyType,
  [in]           WINBIO_PROPERTY_ID       PropertyId,
  [in, optional] WINBIO_UNIT_ID           UnitId,
  [in, optional] WINBIO_IDENTITY          *Identity,
  [in, optional] WINBIO_BIOMETRIC_SUBTYPE SubFactor,
  [in]           PVOID                    PropertyBuffer,
  [in]           SIZE_T                   PropertyBufferSize
);

Parameter

[in] SessionHandle

Ein WINBIO_SESSION_HANDLE Wert, der eine offene biometrische Sitzung identifiziert. Öffnen Sie ein synchrones Sitzungshandle, indem Sie WinBioOpenSession aufrufen. Öffnen Sie ein asynchrones Sitzungshandle, indem Sie WinBioAsyncOpenSession aufrufen.

[in] PropertyType

Ein WINBIO_PROPERTY_TYPE Wert, der den Typ der Eigenschaft angibt, die Sie festlegen möchten. Dies muss derzeit WINBIO_PROPERTY_TYPE_ACCOUNT sein.

[in] PropertyId

Ein WINBIO_PROPERTY_ID Wert, der die festzulegende Eigenschaft angibt. Dies muss derzeit WINBIO_PROPERTY_ANTI_SPOOF_POLICY sein. Alle anderen Eigenschaften sind schreibgeschützt.

[in, optional] UnitId

Ein WINBIO_UNIT_ID Wert, der die biometrische Einheit identifiziert. Für die WINBIO_PROPERTY_ANTI_SPOOF_POLICY-Eigenschaft muss dieser Wert 0 sein.

[in, optional] Identity

Adresse einer WINBIO_IDENTITY Struktur, die das Konto angibt, für das Sie die Eigenschaft festlegen möchten.

[in, optional] SubFactor

Reserviert. Dies muss WINBIO_SUBTYPE_NO_INFORMATION sein.

[in] PropertyBuffer

Ein Zeiger auf eine Struktur, die den neuen Wert für die -Eigenschaft angibt. Dieser Wert darf nicht NULL sein. Zum Festlegen der WINBIO_PROPERTY_ANTI_SPOOF_POLICY-Eigenschaft muss die Struktur eine WINBIO_ANTI_SPOOF_POLICY-Struktur sein.

[in] PropertyBufferSize

Die Größe der Struktur in Bytes, auf die der PropertyBuffer-Parameter verweist. Dieser Wert darf nicht 0 sein.

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_HANDLE	Das vom SessionHandle-Parameter angegebene Sitzungshandle ist ungültig.
E_POINTER	Die Parameter Identity und PropertyBuffer dürfen nicht NULL sein.
E_INVALIDARG	Der PropertyType-, PropertyId- oder PropertyBufferSize-Parameter darf nicht 0 sein.
WINBIO_E_INVALID_PROPERTY_TYPE	Der Wert des PropertyType-Arguments ist falsch.
WINBIO_E_INVALID_PROPERTY_ID	Der Wert des PropertyId-Arguments ist falsch.
WINBIO_E_LOCK_VIOLATION	Der Aufrufer hat versucht, eine Eigenschaft festzulegen, die sich innerhalb eines gesperrten Bereichs befindet.
WINBIO_E_UNSUPPORTED_PROPERTY	Das -Objekt unterstützt die angegebene Eigenschaft nicht.
WINBIO_E_ENROLLMENT_IN_PROGRESS	Der Vorgang konnte nicht abgeschlossen werden, da die angegebene biometrische Einheit derzeit für eine Registrierungstransaktion (nur Systempool) verwendet wird.

Hinweise

Um WinBioSetProperty synchron zu verwenden, rufen Sie die Funktion mit einem Sitzungshandle auf, das durch Aufrufen von WinBioOpenSession erstellt wird. Die Funktion wird blockiert, bis der Vorgang abgeschlossen ist oder ein Fehler auftritt. Um Speicherverluste zu verhindern, müssen Sie WinBioFree aufrufen, um den Speicher freizugeben, auf den der PropertyBuffer-Parameter verweist, wenn Sie die im Puffer enthaltenen Daten nicht mehr verwenden.

Um WinBioSetProperty asynchron zu verwenden, rufen Sie die Funktion mit einem Sitzungshandle auf, das durch Aufrufen von WinBioAsyncOpenSession erstellt wird. Das Framework ordnet eine WINBIO_ASYNC_RESULT-Struktur zu und verwendet sie, um Informationen über erfolgreiche oder fehlgeschlagene Vorgänge zurückzugeben. Die WINBIO_ASYNC_RESULT-Struktur wird an den Anwendungsrückruf oder die Anwendungsnachrichtenwarteschlange zurückgegeben, je nachdem, welche Werte Sie im NotificationMethod-Parameter der WinBioAsyncOpenSession-Funktion festgelegt haben:

Wenn Sie Vervollständigungsbenachrichtigungen mithilfe eines Rückrufs erhalten möchten, müssen Sie eine PWINBIO_ASYNC_COMPLETION_CALLBACK-Funktion implementieren und den NotificationMethod-Parameter auf WINBIO_ASYNC_NOTIFY_CALLBACK festlegen.
Wenn Sie Vervollständigungsbenachrichtigungen mithilfe der Anwendungsnachrichtenwarteschlange empfangen möchten, müssen Sie den NotificationMethod-Parameter auf WINBIO_ASYNC_NOTIFY_MESSAGE festlegen. Das Framework gibt einen WINBIO_ASYNC_RESULT Zeiger auf das LPARAM-Feld der Fenstermeldung zurück.

Um Speicherverluste zu verhindern, müssen Sie WinBioFree aufrufen, um die WINBIO_ASYNC_RESULT-Struktur freizugeben, nachdem Sie sie verwendet haben.

Anforderungen


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

WinBioFree

WinBioGetProperty

Freigeben über