PIBIO_ENGINE_QUERY_SAMPLE_HINT_FN Rückruffunktion (winbio_adapter.h)

  • Artikel

Wird vom Windows Biometric Framework aufgerufen, um die Anzahl der richtigen Beispiele abzurufen, die für den Moduladapter zum Erstellen einer Registrierungsvorlage erforderlich sind.

Syntax

PIBIO_ENGINE_QUERY_SAMPLE_HINT_FN PibioEngineQuerySampleHintFn;

HRESULT PibioEngineQuerySampleHintFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PSIZE_T SampleHint
)
{...}

Parameter

[in, out] Pipeline

Zeiger auf eine WINBIO_PIPELINE Struktur, die der biometrischen Einheit zugeordnet ist, die den Vorgang ausführt.

[out] SampleHint

Zeiger auf eine Variable, die die Anzahl der erforderlichen Stichproben empfängt.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück. Wenn die Funktion fehlschlägt, muss sie einen der folgenden HRESULT-Werte zurückgeben, um den Fehler anzugeben.

Rückgabecode Beschreibung
E_POINTER
 Ein obligatorischer Zeigerparameter ist NULL.
WINBIO_E_UNSUPPORTED_PROPERTY
 Diese Eigenschaft wird vom Moduladapter nicht unterstützt.

Hinweise

Wenn ein Engineadapter in verschiedenen Situationen eine andere Anzahl von Beispielen erfordert, sollten Sie die größte Anzahl zurückgeben. Wenn ein Fingerabdruckmodul beispielsweise mehr Wischvorgänge für einen Zeigefinger als für einen Daumen erfordert, geben Sie die für den Zeigefinger erforderliche Zahl zurück.

Der vom SampleHint-Parameter zurückgegebene Wert gibt die Anzahl der erforderlichen korrekten Beispiele an. Aufgrund fehlerhafter Erfassungen kann die tatsächliche Anzahl der während der Registrierung erforderlichen Proben größer sein als die angegebene Anzahl.

Beispiele

Der folgende Pseudocode zeigt eine mögliche Implementierung dieser Funktion. Das Beispiel wird nicht kompiliert. Sie müssen es an Ihren Zweck anpassen.

//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterQuerySampleHint
//
// Purpose: 
//      Retrieves the number of correct samples required by the engine adapter 
//      to construct an enrollment template.
//
// Parameters:
//      Pipeline    - Pointer to a WINBIO_PIPELINE structure associated 
//                    with the biometric unit performing the operation. 
//      SampleHint  - Pointer to a variable that receives the number of 
//                    required samples.
//
static HRESULT
WINAPI
EngineAdapterQuerySampleHint(
    __inout PWINBIO_PIPELINE Pipeline,
    __out PSIZE_T SampleHint
    )
{
    // Verify that pointer arguments are not NULL.
    if (!ARGUMENT_PRESENT(Pipeline) ||
        !ARGUMENT_PRESENT(SampleHint))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // The sample hint specified here is a constant but can also be a 
    // function of the hardware model or the device settings depending
    // on your adapter.
    // If your adapter does not support this feature, return
    // WINBIO_E_UNSUPPORTED_PROPERTY.
    *SampleHint = SAMPLES_REQUIRED_FOR_ENROLLMENT;

cleanup:

    return hr;
}

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile winbio_adapter.h (einschließlich Winbio_adapter.h)

Weitere Informationen

EngineAdapterAcceptSampleData

Plug-In-Funktionen