Edit

PIBIO_ENGINE_SET_ENROLLMENT_PARAMETERS_FN callback function (winbio_adapter.h)

  • Article

Called by the Windows Biometric Framework to give the engine adapter additional information about an enrollment operation.

Syntax

PIBIO_ENGINE_SET_ENROLLMENT_PARAMETERS_FN PibioEngineSetEnrollmentParametersFn;

HRESULT PibioEngineSetEnrollmentParametersFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      PWINBIO_EXTENDED_ENROLLMENT_PARAMETERS Parameters
)
{...}

Parameters

[in, out] Pipeline

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

[in] Parameters

Pointer to the WINBIO_EXTENDED_ENROLLMENT_PARAMETERS structure containing the extended enrollment parameters to use.

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.

Remarks

If the engine adapter successfully completes an EngineAdapterCreateEnrollment call, it will immediately receive a call to its EngineAdapterSetEnrollmentParameters function.

This function specifies the subfactor to be used for the new enrollment template.

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)