Biometric

Overview of the Biometric technology.

To develop Biometric, you need these headers:

For the programming guide, see Biometric.

Structures

Title Description
_WINBIO_BIR structure The WINBIO_BIR structure is the root of the BIR (Biometric Information Record). It contains the size and offset of any other data elements in the BIR.
_WINBIO_BIR_DATA structure The WINBIO_BIR_DATA structure contains the location and size of a block in a BIR. The offset is measured from the beginning of the WINBIO_BIR structure.
_WINBIO_BIR_HEADER structure The WINBIO_BIR_HEADER structure contains the Common Biometric Exchange File Format (CBEFF) Patron Format A information that describes the rest of the BIR.
_WINBIO_BLANK_PAYLOAD structure The IOCTL_BIOMETRIC_RESET and IOCTL_BIOMETRIC_UPDATE_FIRMWARE IOCTLs return the WINBIO_BLANK_PAYLOAD structure as output.
_WINBIO_CALIBRATION_INFO structure The IOCTL_BIOMETRIC_CALIBRATE IOCTL returns the WINBIO_CALIBRATION_INFO structure as output.
_WINBIO_CAPTURE_DATA structure The IOCTL_BIOMETRIC_CAPTURE_DATA IOCTL returns the WINBIO_CAPTURE_DATA structure as output.
_WINBIO_CAPTURE_PARAMETERS structure The IOCTL_BIOMETRIC_CAPTURE_DATA IOCTL uses the WINBIO_CAPTURE_PARAMETERS structure as input.
_WINBIO_DATA structure The WINBIO_DATA structure specifies data in IOCTL payloads.
_WINBIO_DIAGNOSTICS structure The IOCTL_BIOMETRIC_GET_SENSOR_STATUS IOCTL returns the WINBIO_DIAGNOSTICS structure as output.
_WINBIO_GET_INDICATOR structure The WINBIO_GET_INDICATOR structure is the OUT payload for IOCTL_BIOMETRIC_GET_INDICATOR.
_WINBIO_REGISTERED_FORMAT structure The WINBIO_REGISTERED_FORMAT structure specifies a biometric data format.
_WINBIO_SENSOR_ATTRIBUTES structure The IOCTL_BIOMETRIC_GET_ATTRIBUTES structure returns the WINBIO_SENSOR_ATTRIBUTES structure as output.
_WINBIO_SET_INDICATOR structure The WINBIO_SET_INDICATOR structure is the IN payload for IOCTL_BIOMETRIC_SET_INDICATOR.
_WINBIO_SUPPORTED_ALGORITHMS structure The WINBIO_SUPPORTED_ALGORITHMS structure is the OUT payload for IOCTL_BIOMETRIC_GET_SUPPORTED_ALGORITHMS.
_WINBIO_UPDATE_FIRMWARE structure The WINBIO_UPDATE_FIRMWARE structure is the IN payload for IOCTL_BIOMETRIC_UPDATE_FIRMWARE.
_WINBIO_VERSION structure The WINBIO_VERSION structure describes major and minor version information for a WBDI driver.

I/O control codes

Title Description
IOCTL_BIOMETRIC_CALIBRATE IOCTL The IOCTL_BIOMETRIC_CALIBRATE IOCTL directs the driver to perform any necessary steps to calibrate the device for use.
IOCTL_BIOMETRIC_CAPTURE_DATA IOCTL The IOCTL_BIOMETRIC_CAPTURE_DATA IOCTL directs the driver to retrieve the next scan of biometric data. This call should put the device into capture mode.Vendor-supplied WBDI drivers must support IOCTL_BIOMETRIC_CAPTURE_DATA.
IOCTL_BIOMETRIC_GET_ATTRIBUTES IOCTL The IOCTL_BIOMETRIC_GET_ATTRIBUTES IOCTL returns a structure that contains a set of attributes for the sensor. Vendor-supplied WBDI drivers must support this IOCTL.
IOCTL_BIOMETRIC_GET_INDICATOR IOCTL The IOCTL_BIOMETRIC_GET_INDICATOR IOCTL directs the driver to retrieve the status of the indicator light. This IOCTL is optional.
IOCTL_BIOMETRIC_GET_SENSOR_STATUS IOCTL The IOCTL_BIOMETRIC_GET_SENSOR_STATUS IOCTL tells the driver to perform any necessary steps to collect the current operating status of the device. Vendor-supplied WBDI drivers must support this IOCTL.
IOCTL_BIOMETRIC_GET_SUPPORTED_ALGORITHMS IOCTL The IOCTL_BIOMETRIC_GET_SUPPORTED_ALGORITHMS IOCTL retrieves a list of cryptographic hash algorithms that are supported by the device. This IOCTL is optional.
IOCTL_BIOMETRIC_RESET IOCTL The IOCTL_BIOMETRIC_RESET IOCTL resets the device to a known or idle state, according to the current power state. Vendor-supplied WBDI drivers must support this IOCTL.
IOCTL_BIOMETRIC_SET_INDICATOR IOCTL The IOCTL_BIOMETRIC_SET_INDICATOR IOCTL directs the driver to update the status of the indicator light.
IOCTL_BIOMETRIC_UPDATE_FIRMWARE IOCTL The IOCTL_BIOMETRIC_UPDATE_FIRMWARE IOCTL tells the driver to update the firmware for the device with the given firmware image. This IOCTL is optional.