IOCTL_BIOMETRIC_CALIBRATE IOCTL

The IOCTL_BIOMETRIC_CALIBRATE IOCTL directs the driver to perform any necessary steps to calibrate the device for use. Internally, the driver may also collect and return vendor specific calibration data to be analyzed by an application. Vendor-supplied WBDI drivers must support this IOCTL.

Major Code

IRP_MJ_DEVICE_CONTROL

Input Buffer

None.

Input Buffer Length

None.

Output Buffer

The AssociatedIrp.SystemBuffer member points to a buffer that contains a WINBIO_CALIBRATION_INFO structure.

Output Buffer Length

Length of a WINBIO_CALIBRATION_INFO structure.

The vendor-supplied driver can optionally return a DWORD-sized buffer that specifies the buffer size necessary for the requested operation.

Status Block

Indicates whether the DeviceIoControl call to the driver completed and the OUT payload is valid.

The Status member is set to one of the values in the following table.

Status value Description
S_OK, STATUS_SUCCESS The operation completed successfully. If the size of data returned is DWORD, the payload contains the size of the buffer necessary for the call. Otherwise, the payload contains the full output buffer.
E_INVALIDARG The parameters were not specified correctly.
E_UNKNOWN Any other failure that prevents the payload from being filled in.
E_UNEXPECTED Any other failure that prevents the payload from being filled in.
E_FAIL Any other failure that prevents the payload from being filled in.

Remarks

If the vendor-supplied driver passes back the entire payload, it should fill in the WinBioHresult member of WINBIO_CALIBRATION_INFO with the status of the Biometric operation.

Requirements

   
Windows version Available in Windows 7 and later versions of Windows.
Header winbio_ioctl.h