Edit

Share via

PIBIO_SENSOR_SET_MODE_FN callback function (winbio_adapter.h)

  • Article

Called by the Windows Biometric Framework to set the sensor adapter mode.

Syntax

PIBIO_SENSOR_SET_MODE_FN PibioSensorSetModeFn;

HRESULT PibioSensorSetModeFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      WINBIO_SENSOR_MODE Mode
)
{...}

Parameters

[in, out] Pipeline

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

[in] Mode

A WINBIO_SENSOR_MODE value. This can be one of the following values:

  • WINBIO_SENSOR_UNKNOWN_MODE
  • WINBIO_SENSOR_BASIC_MODE
  • WINBIO_SENSOR_ADVANCED_MODE
  • WINBIO_SENSOR_NAVIGATION_MODE
  • WINBIO_SENSOR_SLEEP_MODE

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 argument cannot be NULL.
WINBIO_E_DEVICE_FAILURE
There was a hardware failure.
WINBIO_E_INVALID_DEVICE_STATE
 The SensorContext member of the WINBIO_PIPELINE structure pointed to by the Pipeline argument is NULL or the SensorHandle member is set to INVALID_HANDLE_VALUE.
WINBIO_E_INVALID_SENSOR_MODE
 The sensor adapter does not support the value specified by the Mode parameter.

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

Plug-in Functions