PosBarcodeScannerErrorOccurredEventData structure (pointofservicedriverinterface.h)

This structure contains the error data that is passed to the BarcodeScannerErrorOccurred event.

Syntax

typedef struct _PosBarcodeScannerErrorOccurredEventData {
  PosEventDataHeader                     Header;
  LONG                                   IsRetriable;
  DriverUnifiedPosErrorSeverity          Severity;
  UINT32                                 VendorErrorCode;
  DriverUnifiedPosErrorReason            Reason;
  UINT32                                 ExtendedReason;
  UINT32                                 MessageLength;
  PosBarcodeScannerDataReceivedEventData PartialData;
} PosBarcodeScannerErrorOccurredEventData;

Members

Header

The PosEventDataHeader structure that describes the amount of memory, in bytes, of the PosBarcodeScannerErrorOccurredEventData structure and trailing error message and scan data.

IsRetriable

Indicates whether ReadFile can be called again to read this event

Severity

Contains a value in the UnifiedPosErrorSeverity enumeration indicating the severity of the error.

VendorErrorCode

Contains a vendor-specific error code.

Reason

Contains a value in the UnifiedPosErrorReason enumeration indicating the reason for the error.

ExtendedReason

Contains additional data about the reason for the error.

MessageLength

Indicates the length, in bytes, of the error message.

PartialData

If a scanning error occurs, and some scan data was obtained, the partial scan data will be available in this parameter.

Remarks

The error data should fill the buffer as shown in the following table (in order).

Data	Length in bytes
PosBarcodeScannerErrorOccurredEventData structure	sizeof(PosBarcodeScannerErrorOccurredEventData)
Error message text	MessageLength
Partial scan data	PartialData.ScanDataLength
Label data	PartialData.ScanDataLabelLength

Requirements

Requirement	Value
Header	pointofservicedriverinterface.h (include PointOfServiceDriverInterface.h)