PIBIO_SENSOR_GET_INDICATOR_STATUS_FN callback function (winbio_adapter.h)
Called by the Windows Biometric Framework to retrieve a value that indicates whether the sensor indicator is on or off.
Syntax
PIBIO_SENSOR_GET_INDICATOR_STATUS_FN PibioSensorGetIndicatorStatusFn;
HRESULT PibioSensorGetIndicatorStatusFn(
[in, out] PWINBIO_PIPELINE Pipeline,
[out] PWINBIO_INDICATOR_STATUS IndicatorStatus
)
{...}
Parameters
[in, out] Pipeline
Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.
[out] IndicatorStatus
Pointer to a WINBIO_INDICATOR_STATUS value. This can be one of the following:
- WINBIO_INDICATOR_ON
- WINBIO_INDICATOR_OFF
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 |
---|---|
|
A mandatory pointer parameter is NULL. |
|
There was a hardware failure. |
|
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. |
|
The sensor does not have an indicator. |
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) |