CsUserDefs.h File Reference

Definitions related to CoreScanner interface. More...

Go to the source code of this file.

Enumerations
enum	CmdOpcode {   CMD_GET_VERSION = 0x3E8, CMD_REGISTER_FOR_EVENTS = 0x3E9, CMD_CLAIM_DEVICE = 0x5DC, CMD_RELEASE_DEVICE = 0x5DD,   CMD_DEVICE_ABORT_UPDATE_FIRMWARE = 0x7D1, CMD_DEVICE_AIM_OFF = 0x7D2, CMD_DEVICE_AIM_ON = 0x7D3, CMD_DEVICE_LED_OFF = 0x7D9,   CMD_DEVICE_LED_ON = 0x7DA, CMD_DEVICE_PULL_TRIGGER = 0x7DB, CMD_DEVICE_RELEASE_TRIGGER = 0x7DC, CMD_DEVICE_SCAN_DISABLE = 0x7DD,   CMD_DEVICE_SCAN_ENABLE = 0x7DE, CMD_DEVICE_BEEP_CONTROL = 0x7E2, CMD_REBOOT_SCANNER = 0x7E3, CMD_DEVICE_CAPTURE_IMAGE = 0xBB8,   CMD_DEVICE_CAPTURE_BARCODE = 0xDAC, CMD_DEVICE_CAPTURE_VIDEO = 0xFA0, CMD_RSM_ATTR_GETALL = 0x1388, CMD_RSM_ATTR_GET = 0x1389,   CMD_RSM_ATTR_GETNEXT = 0x138A, CMD_RSM_ATTR_SET = 0x138C, CMD_RSM_ATTR_STORE = 0x138D, CMD_GET_DEVICE_TOPOLOGY = 0x138E,   CMD_REFRESH_TOPOLOGY = 0x138F, CMD_START_NEW_FIRMWARE = 0x1396, CMD_DEVICE_UPDATE_FIRMWARE = 0x1398, CMD_DEVICE_UPDATE_FIRMWARE_FROM_PLUGIN = 0x1399,   CMD_LOAD_CONFIGURATION = 0x139C, CMD_DEVICE_SWITCH_HOST_MODE = 0x1838, CMD_SWITCH_CDC_DEVICES = 0x1839 }
enum	StatusID {   STATUS_OK = 0, STATUS_ERROR = 1, STATUS_ERROR_PARTIAL_SUCCESS = 8, STATUS_ERROR_DEVICE_NOT_AVAILABLE = 4,   STATUS_ERROR_COMMAND_RESPONSE_TIMED_OUT = 7, STATUS_ERROR_COMMLIB_UNAVAILABLE = 101, STATUS_ERROR_INCORRECT_BUFFER_SIZE = 104, STATUS_ERROR_INVALID_ARG = 107,   STATUS_ERROR_INVALID_SCANNERID = 108, STATUS_ERROR_INCORRECT_NUMBER_OF_EVENTS = 109, STATUS_ERROR_DUPLICATE_EVENTID = 110, STATUS_ERROR_INVALID_EVENTID = 111,   STATUS_ERROR_DEVICE_UNAVAILABLE = 112, STATUS_ERROR_INVALID_OPCODE = 113, STATUS_ERROR_INVALID_TYPE = 114, STATUS_ERROR_ASYNC_NOT_SUPPORTED = 115,   STATUS_ERROR_OPCODE_NOT_SUPPORTED = 116, STATUS_ERROR_OPERATION_FAILED = 117, STATUS_ERROR_REQUEST_FAILED = 118, STATUS_ERROR_OPERATION_NOT_SUPPORTED_FOR_AUXILIARY_SCANNERS = 119,   STATUS_ERROR_DEVICE_BUSY = 120, STATUS_ERROR_CDC_SCANNERS_NOT_FOUND = 150, STATUS_ERROR_UNABLE_TO_OPEN_CDC_COM_PORT = 151, STATUS_ERROR_ALREADY_OPENED = 200,   STATUS_ERROR_ALREADY_CLOSED = 201, STATUS_ERROR_CLOSED = 202, STATUS_ERROR_INVALID_INXML = 300, ERROR_FW_INVALID_DATFILE = 500,   ERROR_FW_UPDATE_FAILED_IN_SCN = 501, ERROR_FW_READ_FAILED_DATFILE = 502, ERROR_FW_UPDATE_INPROGRESS = 503, ERROR_FW_UPDATE_ALREADY_ABORTED = 504,   ERROR_FW_UPDATE_ABORTED = 505, ERROR_FW_SCN_DETTACHED = 506, STATUS_FW_SWCOMP_RESIDENT = 600, STATUS_ERROR_INVALID_CONFIG_FILE = 601,   STATUS_ERROR_INCOMPATIBLE_CONFIG_FILE = 602, STATUS_ERROR_CONFIG_FILE_SYNTAX_VALIDATION_FAILED = 603 }
enum	EventSubscriptionFlags {   SUBSCRIBE_NONE = 0, SUBSCRIBE_BARCODE = 1, SUBSCRIBE_IMAGE = 2, SUBSCRIBE_VIDEO = 4,   SUBSCRIBE_RMD = 8, SUBSCRIBE_PNP = 16, SUBSCRIBE_CMD_REPONSE = 32, SUBSCRIBE_DIO = 64,   SUBSCRIBE_NOTIFICATION = 128 }
enum	UpdateFirmwareEventID {   SCANNER_UF_SESS_START = 11, SCANNER_UF_DL_START = 12, SCANNER_UF_DL_PROGRESS = 13, SCANNER_UF_DL_END = 14,   SCANNER_UF_SESS_END = 15, SCANNER_UF_STATUS = 16, SCANNER_UC_SESS_START = 17, SCANNER_UC_PROGRESS = 18,   SCANNER_UC_SESS_END = 19 }
enum	PnpEventType { SCANNER_ATTACHED = 0, SCANNER_DETACHED = 1 }
enum	ImageEventType { IMAGE_COMPLETE = 1, IMAGE_TRAN_STATUS = 2 }
enum	VideoEventType { VIDEO_FRAME_COMPLETE = 1 }
enum	ImageType { BMP_FILE_SECTION = 3, TIFF_FILE_SECTION = 4, JPEG_FILE_SECTION = 1, ISO_IEC_15434_TYPE = 5 }
enum	ScannerType {   SCANNER_TYPE_ALL = 0xffff, SCANNER_TYPE_SNAPI = 1, SCANNER_TYPE_IBMHID = 2, SCANNER_TYPE_IBMTT = 4,   SCANNER_TYPE_HIDKB = 8, SCANNER_TYPE_INVALID = 0 }
enum	ScannerNotificationType {   SCANNER_NOTIFICATION_UKNOWN =0, SCANNER_NOTIFICATION_DECODE_MODE, SCANNER_NOTIFICATION_SNAPSHOT_MODE, SCANNER_NOTIFICATION_VIDEO_MODE,   SCANNER_NOTIFICATION_NO_DECODE_EVENT = 1001 }

Detailed Description

Definitions related to CoreScanner interface.

Enumeration Type Documentation

enum CmdOpcode

Enumerator
CMD_GET_VERSION	1000< Gets the version of CoreScanner Driver
CMD_REGISTER_FOR_EVENTS	1001< Register for API events described API Events beginning on
CMD_CLAIM_DEVICE	1500< Claim a specified device
CMD_RELEASE_DEVICE	1501< Release a claimed device
CMD_DEVICE_ABORT_UPDATE_FIRMWARE	2001< Abort Firmware updates process of a specified scanner while it is progressing
CMD_DEVICE_AIM_OFF	2002< Turn off the aiming of a specified scanner
CMD_DEVICE_AIM_ON	2003< Turn on the aiming of a specified scanner
CMD_DEVICE_LED_OFF	2009< Turn off LED of a specified scanner
CMD_DEVICE_LED_ON	2010< Turn on LED of specified scanner
CMD_DEVICE_PULL_TRIGGER	2011< Pull the trigger of a specified scanner
CMD_DEVICE_RELEASE_TRIGGER	2012< Release the pulled trigger of a specified scanner
CMD_DEVICE_SCAN_DISABLE	2013< Disable scanning on a specified scanner
CMD_DEVICE_SCAN_ENABLE	2014< Enable scanning on a specified scanner
CMD_DEVICE_BEEP_CONTROL	2018< Control the beep
CMD_REBOOT_SCANNER	2019< Reboot a specified scanner.
CMD_DEVICE_CAPTURE_IMAGE	3000< Change a specified scanner to snapshot mode.
CMD_DEVICE_CAPTURE_BARCODE	3500< Change a specified scanner to decode mode
CMD_DEVICE_CAPTURE_VIDEO	4000< Change a specified scanner to video mode.
CMD_RSM_ATTR_GETALL	5000< Get all the attributes of a specified scanner.
CMD_RSM_ATTR_GET	5001< Query the values of attribute(s) of a specified scanner.
CMD_RSM_ATTR_GETNEXT	5002< Query the value of the next attribute to a given attribute of a specified scanner.
CMD_RSM_ATTR_SET	5004< Set the values of attribute(s) of a specified scanner.
CMD_RSM_ATTR_STORE	5005< Store the values of attribute(s) of a specified scanner.
CMD_GET_DEVICE_TOPOLOGY	5006< Get the topology of devices that are connected to the calling system
CMD_REFRESH_TOPOLOGY	5007< Refresh the topology of devices that are connected to the calling system
CMD_START_NEW_FIRMWARE	5014< Start the updated firmware. This reboots the scanner
CMD_DEVICE_UPDATE_FIRMWARE	5016< Update the firmware of the specified scanner.
CMD_DEVICE_UPDATE_FIRMWARE_FROM_PLUGIN	5017< Update the firmware of the specified scanner using a scanner plug-in.
CMD_LOAD_CONFIGURATION	5020< Load configuration (.SCNCFG) file configurations to scanner device
CMD_DEVICE_SWITCH_HOST_MODE	6200< Switch the USB host mode of a specified scanner
CMD_SWITCH_CDC_DEVICES	6201< Switch CDC devices

enum EventSubscriptionFlags

Enumerator
SUBSCRIBE_NONE	No event subscription
SUBSCRIBE_BARCODE	Subscribe for Barcode events
SUBSCRIBE_IMAGE	Subscribe for Image events
SUBSCRIBE_VIDEO	Subscribe for Video events
SUBSCRIBE_RMD	Subscribe for RMD events
SUBSCRIBE_PNP	Subscribe for PNP events
SUBSCRIBE_CMD_REPONSE	Subscribe for CMD events
SUBSCRIBE_DIO	Subscribe for DIO events
SUBSCRIBE_NOTIFICATION	Subscribe for Notification events

enum ImageEventType

Enumerator
IMAGE_COMPLETE	A complete image is captured
IMAGE_TRAN_STATUS	Image error or status

enum ImageType

Enumerator
BMP_FILE_SECTION	BMP
TIFF_FILE_SECTION	TIFF
JPEG_FILE_SECTION	JPEG
ISO_IEC_15434_TYPE	IDC

enum PnpEventType

Enumerator
SCANNER_ATTACHED	Zebra scanner is attached
SCANNER_DETACHED	Zebra scanner is detached.

enum ScannerNotificationType

Enumerator
SCANNER_NOTIFICATION_DECODE_MODE	Triggered when a scanner changes its operation mode to decode
SCANNER_NOTIFICATION_SNAPSHOT_MODE	Triggered when a scanner changes its operation mode to image mode
SCANNER_NOTIFICATION_VIDEO_MODE	Triggered when a scanner changes its operation mode to video mode

enum ScannerType

Enumerator
SCANNER_TYPE_ALL	All Scanners
SCANNER_TYPE_SNAPI	SNAPI Scanners
SCANNER_TYPE_IBMHID	IBM Hand-held Scanners
SCANNER_TYPE_IBMTT	IBM Table-top Scanners
SCANNER_TYPE_HIDKB	USB HID Keyboard scanners
SCANNER_TYPE_INVALID	Invalid Scanners

enum StatusID

Enumerator
STATUS_OK	Generic success
STATUS_ERROR	Generic error
STATUS_ERROR_PARTIAL_SUCCESS	Partial success
STATUS_ERROR_DEVICE_NOT_AVAILABLE	Device not available
STATUS_ERROR_COMMAND_RESPONSE_TIMED_OUT	Command respone timeout
STATUS_ERROR_COMMLIB_UNAVAILABLE	Required Comm Lib is unavailable to support the requested Type.
STATUS_ERROR_INCORRECT_BUFFER_SIZE	When registering for events, inXml event count is not eaqual to actual no. of events
STATUS_ERROR_INVALID_ARG	Invalid argument
STATUS_ERROR_INVALID_SCANNERID	Invalid scanner ID
STATUS_ERROR_INCORRECT_NUMBER_OF_EVENTS	Incorrect value for number of Event IDs
STATUS_ERROR_DUPLICATE_EVENTID	Event IDs are duplicated
STATUS_ERROR_INVALID_EVENTID	Invalid value for Event ID
STATUS_ERROR_DEVICE_UNAVAILABLE	Required device is unavailable
STATUS_ERROR_INVALID_OPCODE	Opcode is invalid
STATUS_ERROR_INVALID_TYPE	Invalid value for Type
STATUS_ERROR_ASYNC_NOT_SUPPORTED	OpCode does not support asynchronous method
STATUS_ERROR_OPCODE_NOT_SUPPORTED	Device does not support the OpCode
STATUS_ERROR_OPERATION_FAILED	Operation failed in device
STATUS_ERROR_REQUEST_FAILED	Request failed in CoreScanner
STATUS_ERROR_DEVICE_BUSY	Device Busy. Applications should retry command.
STATUS_ERROR_CDC_SCANNERS_NOT_FOUND	No CDC scanners found in the system.
STATUS_ERROR_UNABLE_TO_OPEN_CDC_COM_PORT	Unable to open CDC port.
STATUS_ERROR_ALREADY_OPENED	CoreScanner is already opened
STATUS_ERROR_ALREADY_CLOSED	CoreScanner is already closed
STATUS_ERROR_CLOSED	CoreScanner is closed
STATUS_ERROR_INVALID_INXML	Malformed in-XML
ERROR_FW_INVALID_DATFILE	Invalid firmware file
ERROR_FW_UPDATE_FAILED_IN_SCN	FW Update failed in scanner
ERROR_FW_READ_FAILED_DATFILE	Failed to read DAT file
ERROR_FW_UPDATE_INPROGRESS	Firmware Update is in progress (cannot proceed another FW Update or another command)
ERROR_FW_UPDATE_ALREADY_ABORTED	Firmware update is already aborted
ERROR_FW_UPDATE_ABORTED	FW Update aborted
ERROR_FW_SCN_DETTACHED	Scanner is disconnected while updating firmware
STATUS_FW_SWCOMP_RESIDENT	The software component is already resident in the scanner
STATUS_ERROR_INVALID_CONFIG_FILE	Configuration file hash check failed. Tampered .scncfg file
STATUS_ERROR_INCOMPATIBLE_CONFIG_FILE	Configuration file is not compatible with selected scanner
STATUS_ERROR_CONFIG_FILE_SYNTAX_VALIDATION_FAILED	Configuration file syntax validation failed

enum UpdateFirmwareEventID

Enumerator
SCANNER_UF_SESS_START	Triggered when flash download session starts
SCANNER_UF_DL_START	Triggered when Component download starts
SCANNER_UF_DL_PROGRESS	Triggered when block(s) of flash completed
SCANNER_UF_DL_END	Triggered when component download ends
SCANNER_UF_SESS_END	Triggered when flash download session end
SCANNER_UF_STATUS	Triggered when update error or status
SCANNER_UC_SESS_START	Triggered when configuration update session starts
SCANNER_UC_PROGRESS	Reports configuration push progress
SCANNER_UC_SESS_END	Triggered when configuration update session end

enum VideoEventType

Enumerator
VIDEO_FRAME_COMPLETE	A complete video frame is captured