PIBIO_ENGINE_QUERY_EXTENDED_ENROLLMENT_STATUS_FN callback function (winbio_adapter.h)

Article
10/13/2021

Called by the Windows Biometric Framework when a client application queries the WINBIO_PROPERTY_EXTENDED_ENROLLMENT_STATUS property.

Syntax

PIBIO_ENGINE_QUERY_EXTENDED_ENROLLMENT_STATUS_FN PibioEngineQueryExtendedEnrollmentStatusFn;

HRESULT PibioEngineQueryExtendedEnrollmentStatusFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PWINBIO_EXTENDED_ENROLLMENT_STATUS EnrollmentStatus,
  [in]      SIZE_T EnrollmentStatusSize
)
{...}

Parameters

[in, out] Pipeline

Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

[out] EnrollmentStatus

Pointer to the WINBIO_EXTENDED_ENROLLMENT_STATUS structure that contains the extended enrollment status information returned by this function.

[in] EnrollmentStatusSize

The specified size in bytes of the extended enrollment status information.

Return value

If the function succeeds, it returns S_OK. If the function fails, it must return one of the following HRESULT values to indicate the error.

Return code	Description
E_POINTER	The Pipeline parameter cannot be NULL.
E_INVALIDARG	The EnrollmentStatusSize parameter indicates that the output buffer is too small.

Remarks

Enrollment applications can request extended enrollment status information after each call to the WinBioEnrollCapture function.

If the biometric unit is not currently an enrollment template when this routine is called, the engine adapter should set the EnrollmentStatus.TemplateStatus field to WINBIO_E_INVALID_OPERATION and return S_OK as the value of the function.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	winbio_adapter.h (include Winbio_adapter.h)

Share via