WINBIO_GET_INDICATOR structure

The WINBIO_GET_INDICATOR structure is the OUT payload for IOCTL_BIOMETRIC_GET_INDICATOR.

Syntax

typedef struct _WINBIO_GET_INDICATOR {
  DWORD                   PayloadSize;
  HRESULT                 WinBioHresult;
  WINBIO_INDICATOR_STATUS IndicatorStatus;
} WINBIO_GET_INDICATOR, *PWINBIO_GET_INDICATOR;

Members

PayloadSize

Specifies the total size of the payload, which includes the fixed length structure and any variable data at the end.

WinBioHresult

Specifies an HRESULT that contains the status of the I/O operation. See IOCTL_BIOMETRIC_GET_INDICATOR for possible values.

IndicatorStatus

Specifies a WINBIO_INDICATOR_STATUS, which indicates whether the indicator light is on or off.

Possible values are shown in the following table.

Indicator status code Description
WINBIO_INDICATOR_ON The indicator light is on, and changes according to the sensor status. To be able to set WINBIO_INDICATOR_ON, you must set WINBIO_CAPABILITY_INDICATOR in the Capabilities member of the WINBIO_SENSOR_ATTRIBUTES structure.
WINBIO_INDICATOR_OFF The sensor indicator light is off. Sensors that do not have an indicator light will always return this value in IOCTL_GET_SENSOR_STATUS.

Requirements

   
Minimum supported client Available in Windows 7 and later versions of Windows.
Header winbio_ioctl.h

See Also

IOCTL_BIOMETRIC_GET_INDICATOR

WINBIO_SET_INDICATOR