PIBIO_ENGINE_GET_ENROLLMENT_STATUS_FN callback function (winbio_adapter.h)

Called by the Windows Biometric Framework to determine whether the enrollment object is ready to be committed to the pipeline.

Syntax

PIBIO_ENGINE_GET_ENROLLMENT_STATUS_FN PibioEngineGetEnrollmentStatusFn;

HRESULT PibioEngineGetEnrollmentStatusFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PWINBIO_REJECT_DETAIL RejectDetail
)
{...}

Parameters

[in, out] Pipeline

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

[out] RejectDetail

A pointer to a WINBIO_REJECT_DETAIL value that receives additional information about the failure to update the enrollment object. If the last update was successful, you should set this variable to zero.

Return value

This function must return one of the following HRESULT values.

Return code	Description
S_OK	The last update succeeded and no additional feature sets are required to complete the template.
E_POINTER	A mandatory pointer parameter is NULL.
WINBIO_E_BAD_CAPTURE	The feature set did not meet the internal enrollment requirements of the engine adapter. Further information about the failure is specified by the RejectDetail parameter.
WINBIO_E_INVALID_DEVICE_STATE	There is no enrollment in progress on this biometric unit.
WINBIO_I_MORE_DATA	The last update succeeded, but the engine adapter requires one or more additional feature sets before it can complete the enrollment template.

Requirements

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

See also

EngineAdapterUpdateEnrollment

Plug-in Functions