Edit

IOCTL_BIOMETRIC_RESET IOCTL (winbio_ioctl.h)

  • Article

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.

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_BLANK_PAYLOAD structure.

Output buffer length

The length of a WINBIO_BLANK_PAYLOAD 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

IOCTL_BIOMETRIC_RESET cancels a data collection IOCTL, if one is pending. If there is a vendor-specific operation in progress, the driver should cancel the operation and reset the device whenever possible.

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

Requirements

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