WinBioAsyncOpenFramework-Funktion (winbio.h)

Öffnet ein Handle für das biometrische Framework. Ab Windows 10, Build 1607, ist diese Funktion für die Verwendung mit einem mobilen Image verfügbar. Sie können dieses Handle verwenden, um biometrische Einheiten, Datenbanken und Dienstanbieter asynchron aufzählen und asynchrone Benachrichtigungen zu erhalten, wenn biometrische Einheiten an den Computer angefügt oder entfernt werden.

Syntax

HRESULT WinBioAsyncOpenFramework(
  [in]           WINBIO_ASYNC_NOTIFICATION_METHOD  NotificationMethod,
  [in, optional] HWND                              TargetWindow,
  [in, optional] UINT                              MessageCode,
  [in, optional] PWINBIO_ASYNC_COMPLETION_CALLBACK CallbackRoutine,
  [in, optional] PVOID                             UserData,
  [in]           BOOL                              AsynchronousOpen,
  [out]          WINBIO_FRAMEWORK_HANDLE           *FrameworkHandle
);

Die Parameter

[in] NotificationMethod

Gibt an, wie Abschlussbenachrichtigungen für asynchrone Vorgänge in dieser Frameworksitzung an die Clientanwendung übermittelt werden sollen. Dies muss einer der folgenden Werte sein.

[in, optional] TargetWindow

Handle des Fensters, das die Abschlusshinweise erhält. Dieser Wert wird ignoriert, es sei denn, der Parameter NotificationMethod ist auf WINBIO_ASYNC_NOTIFY_MESSAGE festgelegt.

[in, optional] MessageCode

Window message code the framework must send to signify completion notices. Dieser Wert wird ignoriert, es sei denn, der Parameter NotificationMethod ist auf WINBIO_ASYNC_NOTIFY_MESSAGE festgelegt. Der Wert muss sich innerhalb des Bereichs WM_APP (0x8000) befinden, um 0xBFFF.

Das Windows Biometric Framework legt den LPARAM-Wert der Nachricht auf die Adresse der WINBIO_ASYNC_RESULT Struktur fest, die die Ergebnisse des Vorgangs enthält. Sie müssen WinBioFree aufrufen, um die Struktur freizugeben, nachdem Sie sie verwendet haben.

[in, optional] CallbackRoutine

Adresse der Rückrufroutine, die für Abschlusshinweise aufgerufen werden soll. Dieser Wert wird ignoriert, es sei denn, der Parameter NotificationMethod ist auf WINBIO_ASYNC_NOTIFY_CALLBACK festgelegt.

[in, optional] UserData

Adresse eines vom Aufrufer bereitgestellten Puffers. Der Puffer wird nicht vom Framework oder der biometrischen Einheit geändert. Sie wird in der WINBIO_ASYNC_RESULT-Struktur zurückgegeben. Ihre Anwendung kann die Daten verwenden, um zu bestimmen, welche Aktionen nach Erhalt des Abschlusshinweiss ausgeführt werden sollen, oder um zusätzliche Informationen über den angeforderten Vorgang zu erhalten.

[in] AsynchronousOpen

Gibt an, ob blockiert werden soll, bis die Frameworksitzung geöffnet wurde. Das Angeben von FALSE bewirkt, dass der Prozess blockiert wird. Wenn WAHR angegeben wird, wird die Sitzung asynchron geöffnet.

Wenn Sie FALSE angeben, um die Frameworksitzung synchron zu öffnen, wird Erfolg oder Fehler direkt von dieser Funktion im HRESULT-Rückgabewert an den Aufrufer zurückgegeben. Wenn die Sitzung erfolgreich geöffnet wird, wird das erste asynchrone Abschlussereignis, das Ihre Anwendung empfängt, für einen asynchronen Vorgang verwendet, der nach dem Öffnen des Frameworks angefordert wird.

Wenn Sie TRUE angeben, um die Framework-Sitzung asynchron zu öffnen, wird der erste empfangene asynchrone Abschlusshinweis zum Öffnen des Frameworks verwendet. Wenn der Parameter NotificationMethod auf WINBIO_ASYNC_NOTIFY_CALLBACK festgelegt ist, werden die Vorgangsergebnisse in der durch den CallbackRoutine-Parameter angegebenen Rückruffunktion an die WINBIO_ASYNC_RESULT Struktur übermittelt. Wenn der Parameter NotificationMethod auf WINBIO_ASYNC_NOTIFY_MESSAGE festgelegt ist, werden die Vorgangsergebnisse an die WINBIO_ASYNC_RESULT Struktur übermittelt, auf die das LPARAM-Feld der Fenstermeldung verweist.

[out] FrameworkHandle

Wenn die Funktion nicht erfolgreich ist, ist dieser Parameter NULL.

Wenn die Sitzung synchron und erfolgreich geöffnet wird, enthält dieser Parameter einen Zeiger auf das Sitzungshandle.

Wenn Sie angeben, dass die Sitzung asynchron geöffnet wird, gibt diese Methode sofort zurück, der Sitzungshandle ist NULL, und Sie müssen die WINBIO_ASYNC_RESULT Struktur untersuchen, um zu ermitteln, ob die Sitzung erfolgreich geöffnet wurde.

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ögliche Werte sind die Werte in der folgenden Tabelle, sind jedoch nicht beschränkt. Eine Liste allgemeiner Fehlercodes finden Sie unter "Allgemeine HRESULT-Werte".

Bemerkungen

Das von der WinBioAsyncOpenFramework-Funktion zurückgegebene Framework-Handle kann verwendet werden, um asynchrone Abschlussbenachrichtigungen für die folgenden Funktionen zu generieren:

• WinBioAsyncEnumBiometricUnits
• WinBioAsyncEnumDatabases
• WinBioAsyncEnumServiceProviders
• WinBioAsyncMonitorFrameworkChanges

Wenn Sie den Parameter "AsynchronousOpen" auf TRUE festlegen, gibt diese Funktion S_OK zurück, sobald sie eine anfängliche Überprüfung der Argumente ausgeführt hat. Alle über diesen Punkt erkannten Fehler werden dem Aufrufer mithilfe der durch den Parameter NotificationMethod angegebenen Methode gemeldet. Das heißt, ein erfolgreicher Rückgabewert gibt nur an, dass die WinBioAsyncOpenFramework-Parameter einwandfrei waren und nicht, dass der Öffnenvorgang erfolgreich war. Um festzustellen, ob der Öffnenvorgang erfolgreich war, müssen Sie die WINBIO_ASYNC_RESULT Struktur untersuchen.

Anforderungen

Siehe auch

WinBioAsyncOpenSession