WINBIO_CAPTURE_DATA structure

The IOCTL_BIOMETRIC_CAPTURE_DATA IOCTL returns the WINBIO_CAPTURE_DATA structure as output.

Syntax


typedef struct _WINBIO_CAPTURE_DATA {
  DWORD                PayloadSize;
  HRESULT              WinBioHresult;
  WINBIO_SENSOR_STATUS SensorStatus;
  WINBIO_REJECT_DETAIL RejectDetail;
  WINBIO_DATA          CaptureData;
} WINBIO_CAPTURE_DATA, *PWINBIO_CAPTURE_DATA;

Members

PayloadSize

The total size of the payload. This includes the fixed length structure and any variable data at the end.

WinBioHresult

The status detail of the I/O operation. This is where WINBIO error and information codes will be passed. The following table shows possible values for this member.

Status valueDescription

S_OK

The operation completed successfully.

WINBIO_E_DATA_COLLECTION_IN_PROGRESS

There is already a data collection IOCTL pending.

WINBIO_E_UNSUPPORTED_DATA_FORMAT

The format specified is not supported by this driver and device.

WINBIO_E_UNSUPPORTED_DATA_TYPE

The type of data requested is not supported by this driver and device.

WINBIO_E_INVALID_DEVICE_STATE

The device could not be put into biometric capture mode. This could be because the device is in another non-data collection mode.

HRESULT_FROM_NT(STATUS_IO_DEVICE_ERROR)

The operation was not completed due to device error.

WINBIO_E_DEVICE_BUSY

The device is in the middle of a vendor-specific operation.

WINBIO_E_CANCELED

The operation was canceled either by the caller, or an IOCTL_BIOMETRIC_RESET request.

WINBIO_E_UNSUPPORTED_PURPOSE

The capture purpose specified is not supported by the driver.

 

SensorStatus

The WINBIO_SENSOR_STATUS status of the sensor after the capture has occurred.

RejectDetail

If the sensor status was WINBIO_SENSOR_REJECT, this member contains a WINBIO_REJECT_DETAIL value.

CaptureData

A structure of type WINBIO_DATA that contains data captured by the device, of the format specified. The Data array member of the WINBIO_DATA structure should contain a WINBIO_BIR structure.

Remarks

Requirements

Version

Available in Windows 7 and later versions of Windows.

Header

Winbio_ioctl.h

See also

IOCTL_BIOMETRIC_CAPTURE_DATA

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft