Symbol.Barcode2
The Config class holds access to all the parameters inside the interface, scanner, reader and decoder objects. Thru this object all setting and parameters can be accessed and modified.
When changes are made to either the decoder class, the reader class or scanner class it is optional to call the Set() method. When any Scan call is made the parameters are automatically set before the scan is made. Attempting to Set any changes in config during a pending scan will result in an exception.
This method Will set all the parameters in the Scanner, Decoder, Reader and Interface Classes
individually if they have been modified.
Restores all default values for decoder, scanner, reader and interface parameters.
This method Will Get all the parameters in the Scanner, Decoder, Reader and Interface Classes.
Data format for the data that is read from barcode scanner. Default is Text
Length of ScanData memory buffer. Default is 55.
Specifies the trigger mode for the scanner. It is set to HARD by default.
Refer to the enumeration for more information.
The Interface property holds the parameters for the interface to the attached bar code reader.
Interface parameters are global to all reads on all open handles on the same scanner.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
The Scanner property provides access to scanning parameters that are available for
all decoders.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
The Reader property holds the parameters for the attached bar code reader.
Reader parameters are global to all reads on all open handles on the same scanner.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
The Decoders property contains decoder parameters that are used by
multiple decoder symbologies.
The property provides access to such decoder parameters
as Enabled and IsSupported, among others.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
This property holds the maximum number of ScanData objects in the OnScan callback or GetScannedData().
If set to -1, the callback will return all that is in the collection. The default value is 1.
The ReaderClass structure holds the parameters for the attached bar code reader.
Reader parameters are global to all reads on all open handles on the same scanner.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
Restores default/saved parameters
This method will Get the current Reader Parameter setting from the device.
This method will Set the changes made to the Reader Parameter and must be called in
order for any changes to the parameters to take affect
Describes the bar code reader type these parameters apply to. Read only.
This value determines the values for ReaderSpecific
The ReaderSpecific holds parameters for one reader type.
The structure of ReaderSpecific depends on the value of ReaderType.
The ReaderSpecificClass holds parameters for one reader type.
The structure of ReaderSpecific depends on the value of ReaderType.
The LaserSpecific property holds laser specific reader parameters.
The ImagerSpecific property holds imager specific reader parameters.
The LaserSpecific class holds laser specific reader parameters.
Describes the type of aiming to use.
Duration in milliseconds for timed aim modes.
Describes the mode of aiming to use.
NOTE: This property is deprecated and it will no longer be supported.
It will be removed in a future release.
Specifies the width of the beam on the device if it's supported.
NOTE: User can query the Barcode2.DeviceInfo.SupportedBeamWidths property to see what beam widths are supported on the device.
Describes the type of vertical rastering to use.
Maximum laser on time in milliseconds. A value of 0 means infinite timeout.
Flag to enable LED decode notification by the scanner device (disables notification in the mobile computer). Currently not used.
Logic level to use when controlling scanner LED. Currently not used.
Flag to enable Klasse Eins laser on time function.
Flag to enable birdirectional redundancy.
Describes the linear security level used during decoding.
Maximum laser on time in milliseconds for laser pointer. A value of 0 means infinite timeout.
Describes, as a percentage, the vertical rastering height to use when the RasterMode is RASTER_MODE_OPEN_ALWAYS.
Describes what type of DBP (Digital Bar Pulse) is being produced by the scan engine.
If the product does not support I2C or if using an older engine the default value for DBP Mode is DBP_NORMAL.
An attempt to change this mode to DBP_COMPOSITE will result in an E_SCN_NOTSUPPORTED error.
This parameter is used to prevent the scanner from decoding the same symbol within
this time interval (applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ).
The continuous read mode is used to perform rapid scans. In order to prevent decoding the
same barcode twice, this parameter is set to an appropriate interval (in milliseconds).
A value of 0 means no interval is required between two successive reads
NOTE: Applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ.
This parameter is used to prevent the scanner from decoding another symbol within
this time interval (applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ).
The continuous read mode is used to perform rapid scans. In order to prevent decoding
too quickly and have enough time to aim before decoding the next barcode,
this parameter is set to an appropriate interval (in milliseconds).
A value of 0 means no interval is required between two successive reads
NOTE: Applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ.
Specifies the adaptive scanning mode.
Adaptive Scanning is enabled by default on devices that support this feature.
Please refer to the remarks section below for information about Adaptive Scanning.
NOTE: User can query the Barcode2.DeviceInfo.IsAdaptiveScanningSupported property
to check if adaptive scanning feature is supported on the device.
ADAPTIVE SCANNING:
The high performance and long working range scan engines such as SE960 will support
the adaptive scanning feature to enable scanning high and low density bar codes.
When adaptive scanning is enabled, the scan engine will automatically toggle
between 2 scan angles, wide and narrow, allowing the scan engine to decode barcodes
as close as 10 inches (high density) and as far as 100 inches (low density).
To determine the type of the scan engine on your device, click on the
Start->System->Settings->System Info and select “ConfigInfo” tab.
The "Scanner" field under this tab provides the name of the scan engine.
The ImagerSpecific class holds imager specific reader parameters.
Describes the type of aiming to use.
Duration in milliseconds for timed aim modes.
Describes the mode of aiming to use.
Maximum Imager ON time in milliseconds. A value of 0 means infinite timeout.
Maximum beam timer in milliseconds for pointer mode. A value of 0 means infinite timeout.
Timeout for image capture (in milliseconds).
Timeout for image compression and processing (in milliseconds).
Describes the linear security level used during decoding.
Focus mode to use.
Focus position to use.
This parameter allows poor quality 1D barcodes to be read,
BUT adversely affecting the overall decoding performance.
This parameter allows the imager to decode only the barcode that is directly under the cross-hair/center
of the reticle. This feature is most useful in applications where multiple barcodes may appear in the
field of view during a decode session and only one of them is targeted for decode. When enabled,
PicklistModeEx will override AimMode if no aiming is chosen and use the AIM_MODE_RETICLE mode. When enabled,
PicklistModeEx may adversely affect overall decoding performance. Also read note on interaction between the
picklist modes and the viewfinder modes (only for imagers that support viewfinder capability).
PICKLIST_DISABLED – Disables picklist mode, so any bar code within the field of view can be decoded.
PICKLIST_HARDWARE_RETICLE – Enables picklist mode so that only the barcode under the projected reticle can be decoded. If the imager does not support a projected reticle then the behavior is same as that of PICKLIST_SOFTWARE_RETICLE.
This parameter allows Direct Part Marking (DPM) bar codes to be read but may adversely affect
overall decoding performance. Direct Part Marking is a way of stamping bar codes directly on
physical objects.
Support for this feature is available on DPM terminals only. If this feature is not available
and user attempts to enable it, an error (E_SCN_NOTSUPPORTED) will result.
This feature cannot be turned on in conjunction with Picklist as both these
modes are mutually exclusive. An attempt to turn on both will result in an error
(E_SCN_NOTSUPPORTED).
Illumination Mode to use.
Specifies the coordinates of the viewfinder on the screen.
When scanning is enabled via an imager that supports the viewfinder,
the user can enable the viewfinder which helps with locating the barcode.
The images displayed on the viewfinder will be scaled to fit in the area specified.
Viewfinder modes supported for scanning.
This parameter allows selection of the different feedback parameters on a successful decode.
Time (in milli seconds) for which the visual display selected by VFFeedback is shown.
This parameter allows the user to select decoding on inverse 1D barcodes.
This parameter is used to prevent the scanner from decoding the same symbol within
this time interval (applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ).
The continuous read mode is used to perform rapid scans. In order to prevent decoding the
same barcode twice, this parameter is set to an appropriate interval (in milliseconds).
A value of 0 means no interval is required between two successive reads
NOTE: Applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ.
This parameter is used to prevent the scanner from decoding another symbol within
this time interval (applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ).
The continuous read mode is used to perform rapid scans. In order to prevent decoding
too quickly and have enough time to aim before decoding the next barcode,
this parameter is set to an appropriate interval (in milliseconds).
A value of 0 means no interval is required between two successive reads
NOTE: Applicable only when AimType is set to AIM_TYPE_CONTINUOUS_READ.
Enables or disables LCD mode for Blockbuster imager devices only.
LCD mode enhances the ability of the Blockbuster imager to
read barcodes from LCD displays such as cell phone screens.
Enabling this mode for Pico imagers and cameras is not required
because they already have the ability to read LCD displays
NOTE: When using the LCD mode, a degradation in performance
may be observed and the aiming crosshair will blink until the
barcode is decoded.
The Scanner class provides access to scanning parameters that are available for
all decoders.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
Restores default/saved parameters
This method will Get the current Scanner Parameter setting from the device.
This method will Set the changes made to the Scanner Parameter and must be called in
order for any changes to the parameters to take affect
A CodeIdTypes member that sets the Code ID prefix to be reported.
A SCANTYPES member that indicates the type of scan to perform.
Time to beep upon successful decode.
Frequency to beep upon successful decode.
Time to light decode LED upon successful decode.
Name of .WAV file to play as feedback upon successful decode.
Time to beep upon start event. Time to beep upon start event.
Frequency to beep upon start event.
Time to light decode LED upon start event.
Name of .WAV file to play as feedback upon start event.
Time to beep upon intermediate event.
Frequency to beep upon intermediate event.
Time to light decode LED upon intermediate event.
Name of .WAV file to play as feedback upon intermediate event.
Time to beep upon fatal error event
Frequency to beep upon fatal error event.
Time to light decode LED upon fatal error event.
Name of .WAV file to play as feedback upon fatal error event
Time to beep upon non-fatal error event.
Frequency to beep upon non-fatal error event.
Time to light decode LED upon non-fatal error event
Name of .WAV file to play as feedback upon non-fatal error event.
Time to beep upon activity event.
Frequency to beep upon activity event.
Time to light decode LED upon activity event.
Name of .WAV file to play as feedback upon activity event.
Time to beep after a read completes when scanner is in buffered-read mode
Frequency to beep after a read completes when scanner is in buffered-read mode.
Time to light decode LED after a read completes when scanner is in buffered-read mode.
Name of .WAV file to play after a read completes when scanner is in buffered-read mode.
The InterfaceClass class holds the parameters for the interface to the attached bar code reader.
Interface parameters are global to all reads on all open handles on the same scanner.
NOTE: Beginning with the ScanMDD file version 6.01, the InterfaceClass object can be accessed before or after enabling the
Reader object. In the earlier versions of ScanMDD, the InterfaceClass object can only be accessed after enabling the Reader object.
The ScanMDD version can be retrieved using the ControlPanel tool available on the support central website.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
Restores default/saved parameters
This method will Get the current Interface Parameter setting from the device.
This method will Set the changes made to the Interface Parameter and must be called in
order for any changes to the parameters to take affect
Provides the interface type which determines the specific interface. Read only.
This interface type determines the values for InterfaceSpecific.
The InterfaceSpecific holds parameters for one interface type.
The value of InterfaceType determines which specific interface parameters to use.
The InterfaceSpecific holds parameters for one interface type.
The parameter values in InterfaceSpecific depends on the interface type.
Provides the CamScan specific interface parameters
Provides the SSI specific interface parameters
Provides the SSI specific interface parameters
Time in milliseconds after power is supplied before engine is ready for use.
NOTE: Changing the default value is not recommended.
Time to wait before re-powering.
Specifies the timeout (in seconds) that Reader.Actions.Enable() will block,
before returning an error if a remote scanner connection is not established.
In order to use this parameter, the user should set the required value
to this property and call Reader.Actions.SetParameter(), before calling Actions.Enable().
NOTE: This is currently applicable only to Bluetooth scanners such as RS507.
Specifies the timeout (in seconds), when a remote scanner is idle in a particular
state (IDLE, WAITING, READY or AIMING), after which the connection between
the mobile computer and the remote scanner is severed to conserve power.
NOTE: This is currently applicable only to Bluetooth scanners such as RS507.
Specifies whether to disconnect any existing Bluetooth connection, between
a remote Bluetooth scanner and the mobile computer, when disabling the Reader object.
True - Disconnect existing Bluetooth connection after disabling the Reader object.
False - Do not disconnect existing Bluetooth connection after disabling the Reader object.
NOTE: This is currently applicable only to Bluetooth scanners such as RS507.
Setting this parameter will only persist for one session. To use this feature effectively,
it is best to set this permanently using Motorola's CtlPanel tool which can be obtained
from the support central website.
Displays the Bluetooth address of the mobile computer as a barcode, when calling Actions.Enable().
When using Bluetooth scanners such as RS507, the pairing process between the mobile computer
and Bluetooth scanner may require scanning the Bluetooth address of the mobile computer.
If this parameter is set to TRUE, the Bluetooth address will be displayed as a barcode
when the enabling the Reader object. This feature eliminates the need to open external
tools such as BT_Information in order to display the pairing barcode.
NOTE: This is currently applicable only to Bluetooth scanners such as RS507.
Provides the Camscan specific interface parameters
Time in milliseconds after engine is enabled before the laser is turned on.
Time in milliseconds after power is supplied before engine is ready for use.
NOTE: Changing the default value is not recommended.
Time in milliseconds of non-use before dropping to a low-power mode.
The DecodersClass Class contains decoder parameters that are used by
multiple decoder symbologies.
The DecodersClass class provides access to such decoder parameters
as Enabled and IsSupported, among others.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
The Decoders class provides access to decoder specific parameters.
Restores default decoder parameters
This method will Get the supported Decoders from the device.
This method will Set the changes made to the Decoder Parameters and must be called in
order for any changes to the parameters to take affect
Disables all available decoders so that barcodes with those
symbologies will NOT be decoded by the scanner.
The CODE39 property holds the CODE39 specific parameters. These parameters control the decoding and processing of CODE39 bar codes.
UPCE0 parameters property provides access to UPCE0 parameters.
The UPCE1 property provides access to parameters that are available for the UPCE1 decoder.
The UPCA property provides access to parameters that are available for the UPCA decoder.
The UPCEAN property provides access to parameters that are available for the UPC and EAN decoders.
MSI parameters property provides access to MSI parameters.
The EAN8 property provides access to parameters that are available for the EAN8 decoder.
The EAN13 property provides access to parameters that are available for the EAN13 decoder.
The CODABAR property provides access to parameters that are available for the CODABAR decoder.
The D2OF5 property provides access to parameters that are available for the D2OF5 decoder.
The I2OF5 property provides access to parameters that are available for the I2OF5 decoder.
CODE11 property provides a level of abstraction for specific enumerated types.
The CODE93 property provides access to parameters that are available for the CODE93 decoder.
The CODE128 property provides access to parameters that are available for the CODE128 decoder.
The PDF417 property provides access to parameters that are available for the PDF417 decoder.
The IMAGE property holds the Imaging specific parameters. These parameters control the processing of Images.
The TRIOPTIC39 property provides access to parameters that are available for the TRIOPTIC39 decoder.
The MICROPDF property provides access to parameters that are available for the MICROPDF decoder.
The MACROPDF property provides access to parameters that are available for the MACROPDF decoder.
The MAXICODE property provides access to parameters that are available for the MAXICODE decoder.
The DATAMATRIX property provides access to parameters that are available for the DATAMATRIX decoder.
The QRCODE property provides access to parameters that are available for the QRCODE decoder.
The MACROMICROPDF property provides access to parameters that are available for the MACROMICRO decoder.
The RSS14 property provides access to parameters that are available for the RSS14 decoder.
The RSSLIM property provides access to parameters that are available for the RSSLIM decoder.
The RSSEXP property provides access to parameters that are available for the RSSEXP decoder.
The WEBCODE property provides access to parameters that are available for the WEBCODE decoder.
The COMPOSITE_AB property provides access to parameters that are available for the COMPOSITE_AB decoder.
The COMPOSITE_C property provides access to parameters that are available for the COMPOSITE_C decoder.
The TLC39 property provides access to parameters that are available for the TLC39 decoder
The USPOSTNET property provides access to parameters that are available for the USPOSTNET decoder.
The USPLANET property provides access to parameters that are available for the USPLANET decoder.
The UKPOSTAL property provides access to parameters that are available for the UKPOSTAL decoder.
The JAPPOSTAL property provides access to parameters that are available for the JAPPOSTAL decoder.
The AUSPOSTAL property provides access to parameters that are available for the AUSPOSTAL decoder.
The DUTCHPOSTAL property provides access to parameters that are available for the DUTCHPOSTAL decoder.
The CANPOSTAL property provides access to parameters that are available for the CANPOSTAL decoder.
The AZTEC property provides access to parameters that are available for the AZTEC decoder.
The MICROQR property provides access to parameters that are available for the MICROQR decoder.
The KOREAN_3OF5 property provides access to parameters that are available for the KOREAN_3OF5 decoder.
The US4STATE property provides access to parameters that are available for the US4STATE decoder.
The US4STATE_FICS property provides access to parameters that are available for the US4STATE_FICS decoder.
The MATRIX_2OF5 property provides access to parameters that are available for the MATRIX_2OF5 decoder.
The CHINESE_2OF5 property provides access to parameters that are available for the CHINESE_2OF5 decoder.
The CUECODE property provides access to parameters that are available for the CUECODE decoder.
The SIGNATURE property provides access to parameters that are available for the SIGNATURE decoder.
The POINTER property provides access to parameters that are available for the POINTER decoder.
The DOCCAP property provides access to parameters that are available for the DOCCAP (Document Capture, also known as Decode Image Capture) decoder.
An Arraylist of Supported Decoders
An Arraylist of Enabled Decoders
The BaseDecoder class is the parent decoder to all decoders and is inherited by all decoders.
Returns the minimum length of a valid barcode for the decoder.
Returns the maximum length of a valid barcode for the decoder.
Returns whether or not the Decoder is currently enabled.
Returns whether or not the Decoder is supported by the Reader.
The CODE93 class provides access to parameters that are available for the CODE93 decoder.
Flag to enable redundancy.
UPCE0 parameters class provides access to UPCE0 parameters.
The properties MaxLength and MinLength are not used and return 0 at all times.
Flag to enable reporting the bar code check digit.
Controls the preamble applied to the bar code.
Flag to enable conversion from UPCE0 to UPCA bar code. If this flag is set, the bar code is converted to UPCA and UPCA parameters are used.
Overridden. This property is not used. Returns 0 at all times.
Overridden. This property is not used. Returns 0 at all times.
The UPCE1 class provides access to parameters that are available for the UPCE1 decoder.
The properties MaxLength and MinLength are not used and return 0 at all times.
Flag to enable reporting the bar code check digit.
Controls the preamble applied to the bar code.
Flag to enable conversion from UPCE1 to UPCA bar code. If this flag is set, the bar code is converted to UPCA and UPCA parameters are used.
Overridden. This property is not used. Returns 0 at all times.
Overridden. This property is not used. Returns 0 at all times.
The UPCA class provides access to parameters that are available for the UPCA decoder.
The properties MaxLength and MinLength are not used and return 0 at all times.
Flag to enable reporting the bar code check digit.
Controls the preamble applied to the bar code.
Overridden. This property is not used. Returns 0 at all times.
Overridden. This property is not used. Returns 0 at all times.
The UPCEAN class provides access to parameters that are available for the UPC and EAN decoders.
Flag to enable Bookland code decoding.
Specifies the bookland format to use.
Flag to enable converting RSS barcodes to UPC/EAN format. For this setting to work UPC/EAN symbologies must be enabled
Flag to enable Coupon Code decoding.
Flag to enable linear decode.
Flag to enable random weight check digit verification.
The UPC/EAN security level.
Flag to enable length 2 supplementals.
Flag to enable length 5 supplementals.
The supplemental mode.
Retry count for auto-discriminating for supplementals. Possible values are 2 to 20 inclusive. Note that flag is only considered if is set to one of the following values: SUPPLEMENTALS_ AUTO, SUPPLEMENTALS_SMART, SUPPLEMENTALS_378_379, SUPPLEMENTALS_978_979, SUPPLEMENTALS_977 or SUPPLEMENTALS_414_419_434_439.
Used to differentiate between old coupon (UPC/EAN and Code128) and
new GS1 DataBar Coupons.
NOTE: There is an Interim GS1 DataBar Coupon (UPC A and the GS1 DataBar),
which is meant for smooth transition of adaption from old coupon format
to new coupon format. If an interim coupon is presented to the scanner,
it will read old or new potion of it, depending on the report mode setting.
MSI parameters class provides access to MSI parameters.
A flag the sets the redundancy.
The number of check digits to be verified.
The check digit scheme to verify.
Flag to enable reporting the bar code check digit.
The EAN8 class provides access to parameters that are available for the EAN8 decoder.
Flag to enable conversion from EAN8 to EAN13 bar code.
The CODABAR class provides access to parameters that are available for the CODABAR decoder.
Flag to enable redundancy.
Flag to enable CLSI formatting.
Flag to enable NOTIS formatting.
The D2OF5 class provides access to parameters that are available for the D2OF5 decoder.
Flag to enable redundancy.
The I2OF5 class provides access to parameters that are available for the I2OF5 decoder.
Flag to enable redundancy.
The check digit scheme to verify.
Flag to enable reporting the bar code check digit.
Flag to enable conversion from I2OF5 to EAN13 bar code.
CODE11 class provides a level of abstraction for specific enumerated types.
Flag to enable redundancy. If this flag is set, the bar code must be decoded twice before being accepted.
Note: This flag is only considered if LASER_SPECIFIC.LinearSecurityLevel = SECURITY_REDUNDANCY_AND_LENGTH ( = 0 ).
Describes the number of check digits to verify. Possible values are:
CODE11_NO_CHECK_DIGIT ( = 0 ) – no check digit;
CODE11_ONE_CHECK_DIGIT ( = 1 ) – one check digit;
CODE11_TWO_CHECK_DIGIT ( = 2 ) – two check digits.
Flag to enable reporting the bar code check digit(s). This flag requires “CheckDigitCount” to be other than CODE11_NO_CHECK_DIGIT, otherwise the check digit is always transmitted.
The CODE39 structure holds the CODE39 specific parameters. These parameters control the decoding and processing of CODE39 bar codes.
Flag to enable verification of the bar code check digit.
Flag to enable reporting the bar code check digit.
Flag to enable Code 39 barcode concatenation.
Flag to enable full ASCII conversion of the bar code.
Flag to enable redundancy.
Flag to enable conversion of Code 39 bar codes to Code 32.
Flag to enable reporting the Code 32 prefix when a Code 39 bar code is converted.
Specifies the Code39 security level
The CODE128 class provides access to parameters that are available for the CODE128 decoder.
Flag to enable redundancy.
Flag to enable EAN128 subtype.
Flag to enable ISBT128 subtype.
Flag to enable other (non EAN or ISBT) 128 subtype.
The ISBT128 concatenation feature allows a pair of barcodes which meets a certain criteria defined in the ISBT128 spec to be reported as a single barcode. This parameter describes the different concatenation modes available for ISBT128.
Get/Sets the CheckISBTTable parameter.
Specifies the Code128 security level
The TRIOPTIC39 class provides access to parameters that are available for the TRIOPTIC39 decoder.
Flag to enable redundancy.
The MACROPDF class provides access to parameters that are available for the MACROPDF decoder.
Flag to enable reporting of append information.
Flag to enable buffering of labels.
Flag to enable exclusive state.
Flag to enable conversion to PDF417 symbology.
The MACROMICROPDF class provides access to parameters that are available for the MACROMICRO decoder.
Flag to enable reporting of append information.
Flag to enable buffering of labels.
Flag to enable exclusive state.
Flag to enable conversion to MICROPDF symbology.
The DOCCAP class provides access to parameters that are available for the DOCCAP (Document Capture, also known as Decode Image Capture) decoder.
The X axis offset from the center of the barcode to the top left corner of the capture box.
This parameter can accept the negative values.
It is measured as a multiple of barcode elements unit. Range is from -32767 to 32767.
The Y axis offset from the center of barcode to the top left corner of the capture box.
This parameter can accept negative values.
It is measured as a multiple of barcode elements unit. Range is from -32767 to 32767.
The desired Output image width. It is measured as a multiple of barcode element unit.
Range is from 16 to 640.
The desired Output image height. It is measured as a multiple of barcode element unit.
Range is from 16 to 480.
The file format of the desired image.
The requested image output pixel format.
Feature currently supports 8bpp only.
Quality of compressed image when using the JPEG image format.
Range 0 - 100, where 100 is highest quality image
0 means optimize for image size
Maximum compressed image size in kilobytes (KB) when using the JPEG image format.
0 means optimized for image quality.
Important: This Parameter is not currently supported.
Minimum % of pixel accepted in the captured image.
The capture box’s four sides are compared with the output number of pixels. If any of the four side’s falls short decoding is rejected.
The range is 0-100. 0 means this parameter is not used.
Maximum allowed rotation in degrees. All four sides of the capture box are compared either with X or Y axis.
If any of the sides are rotated more than this amount, then the decoding is rejected.
The range is 0-45. 0 means this parameter is not used.
Allows to select/deselect the symbologies of barcode used to trigger document capture (Decode Image capture).
By default, all these symbologies that trigger document capture are selected.
Minimum length of decoded text to start the image capture.
Range is from 0 to 65535.
Default value 0 means no minimum Length checking performed.
Maximum length of decoded text to start the image capture.
Range is from 0 to 65535.
Default value 0 means no maximum length checking performed.
When enabled, the captured image will be resized and cropped to the exact frame defined by ImageWidth and ImageHeight, else the row image will be produced.
It is recommended to use IMAGE_FORMAT_JPEG for ImageFileFormat if this is disabled.
Whether the brightening of the image is required or not.
Whether the sharpening of the image is required or not.
Whether the high blur decoding is required or not.
Whether the box verification required or not.
When enabled it will try to locate an enclosing black lined box around the capture area.
Please make sure that the edges of the box are not broken and clearly visible.
This is applicable to only Barcode Anchored Mode of Document Capture.
Indicates mode of Document Capture (Decode Image Capture).
Specify edge detection type for the document capture
This setting is applicable to only mode and mode of Document Capture.
Indicates trigger mode of the Document Capture.
The class which can be used to select/deselect the symbologies used for document capture (Decode Image capture).
Enabling a symbology is still required before selecting it.
By default, all these symbologies that trigger document capture are selected.
Selects all the relevant symbologies for document capture.
This would trigger document capture (Decode Image Capture) if it finds any of the supported barcode types denoted by individual flags CODE128, ..., EAN128.
Enabling each of these symbologies is still required before selecting it.
By default, all these symbologies that trigger document capture are selected.
Deselects all the relevant symbologies for document capture (Decode Image Capture).
The flag to denote whether CODE128 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether CODE39 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether I2OF5 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether D2OF5 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether CODABAR has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether PDF417 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether DATAMATRIX has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
The flag to denote whether EAN128 has been selected for document capture (Decode Image Capture).
Enabling the symbology is still required before selecting it.
Lists the image file formats supported by DOCCAP (Document Capture, also known as Decode Image Capture) decoder for capturing the image.
JPEG image file format
BMP image file format
TIFF image file format
The WEBCODE class provides access to parameters that are available for the WEBCODE decoder.
Flag to enable the decoding of the GT Webcode subtype.
The COMPOSITE_AB class provides access to parameters that are available for the COMPOSITE_AB decoder.
The check digit scheme to verify.
Enables the use of UPC rules specified in the UPC-EAN params when reporting composite decode data.
The IMAGE Class holds the Imaging specific parameters. These parameters control the processing of Images.
Gets or sets the rectangle used to crop the viewfinder video.
Resolution 1/x (multiple pixels are combined). A parameter value of 0 or 1
does not modify image size at all.
Enables laser aiming during image capture. Enables/Disables use
of aiming reader parameters for image capture.
Enable illumination during image capture.
Requested image file format (See for a list of supported
file formats).
Quality of compressed JPEG image. Range is 0 - 100, where 100 is highest
quality image and 0 means optimize for image size.
Note: JPEG image is optimized for EITHER Quality or Size. Size restrictions
take priority over quality restrictions.
Maximum compressed JPEG image size in kilobytes (KB). 0 means optimize for image quality.
Note: JPEG image is optimized for EITHER Quality or Size. Size restrictions take priority
over quality restrictions.
The COMPOSITE_C class provides access to parameters that are available for the COMPOSITE_C decoder.
Reserved. Do not use.
The KOREAN_3OF5 class provides access to parameters that are available for the KOREAN_3OF5 decoder.
A flag the sets the redundancy.
The MATRIX_2OF5 class provides access to parameters that are available for the MATRIX_2OF5 decoder.
Flag to enable verification of the bar code check digit.
Flag to enable reporting the bar code check digit.
The SIGNATURE class provides access to parameters that are available for the SIGNATURE decoder.
Requested image file format.
Quality of compressed JPEG image. Range is 0 - 100, where 100 is highest quality image and 0 means optimize for image size. Note: JPEG image will be optimized for either Quality or Size. Size restrictions take priority over quality restrictions.
Maximum compressed JPEG image size in kilobytes (KB). 0 means optimize for image quality. Note: JPEG image will be optimized for either Quality or Size. Size restrictions take priority over quality restrictions.
Specifies the desired output image width.
Specifies the desired output image height.
The TLC39 class provides access to parameters that are available for the TLC39 decoder
The MAXICODE class provides access to parameters that are available for the MAXICODE decoder.
The DATAMATRIX class provides access to parameters that are available for the DATAMATRIX decoder.
The PDF417 class provides access to parameters that are available for the PDF417 decoder.
The EAN13 class provides access to parameters that are available for the EAN13 decoder.
Overridden. This property is not used. Returns 0 at all times.
Overridden. This property is not used. Returns 0 at all times.
The MICROPDF class provides access to parameters that are available for the MICROPDF decoder.
The QRCODE class provides access to parameters that are available for the QRCODE decoder.
The RSS14 class provides access to parameters that are available for the RSS14 decoder.
The RSSLIM class provides access to parameters that are available for the RSSLIM decoder.
The RSSEXP class provides access to parameters that are available for the RSSEXP decoder.
The USPOSTNET class provides access to parameters that are available for the USPOSTNET decoder.
The USPLANET class provides access to parameters that are available for the USPLANET decoder.
The UKPOSTAL class provides access to parameters that are available for the UKPOSTAL decoder.
The JAPPOSTAL class provides access to parameters that are available for the JAPPOSTAL decoder.
The AUSPOSTAL class provides access to parameters that are available for the AUSPOSTAL decoder.
Overridden. This property is not used. Returns 0 at all times.
Overridden. This property is not used. Returns 0 at all times.
The DUTCHPOSTAL class provides access to parameters that are available for the DUTCHPOSTAL decoder.
The CANPOSTAL class provides access to parameters that are available for the CANPOSTAL decoder.
The AZTEC class provides access to parameters that are available for the AZTEC decoder.
The MICROQR class provides access to parameters that are available for the MICROQR decoder.
The US4STATE class provides access to parameters that are available for the US4STATE decoder.
The US4STATE_FICS class provides access to parameters that are available for the US4STATE_FICS decoder.
The CHINESE_2OF5 class provides access to parameters that are available for the CHINESE_2OF5 decoder.
The CUECODE class provides access to parameters that are available for the CUECODE decoder.
The POINTER class provides access to parameters that are available for the POINTER decoder.
Barcode reader version class.
Version class constructor
Version of the scanner driver PDD.
Version of the scanner driver MDD.
Version of scanner hardware if applicable
Version of decoder software if applicable
Version of the scanner native API.
Version of the Assembly.
Additional build version information about the decoder module.
The Barcode2 class is the primary class of the Barcode2 class library.
It provides access to all Config, Version and scanning method calls for the barcode reader.
Creates a Barcode2 object. Uses the first default supported scanner on a device that supports multiple scanners (such as laser, camera, imager). The first available scanner is chosen.
// Create new reader, first available reader will be used.
Symbol.Barcode2 MyReader = new Symbol.Barcode2();
Creates a Barcode2 object. Uses the provided scanner device name/ Port name of the device.
This is normally of the form "SCNx:", where the x is the number of the scanner. It provides you an easier way of identifying the exact device you want to use.
Name of the scanner device/port name
//Create a reader with port name
Symbol.Barcode2() MyReader = new Symbol.Barcode2("SCN1:");
Creates a Barcode2 object. Uses the provided scanner device object.
Scanner device object
//get the second SupportedDevices scanner in the list
Symbol.Barcode2.Device MyDevice = Symbol.Barcode2.Devices.SupportedDevices[1];
//Create a reader with the selected scanner
Symbol.Barcode2() MyReader = new Symbol.Barcode2(MyDevice);
Creates a Barcode2 object. Uses the provided scanner device type. It provides you an easier way of identifying the exact device you want to use.
Scanner device type
//Creates a reader to access the 1st internal camera device type
Symbol.Barcode2() MyReader = new Symbol.Barcode2(DEVICETYPES.INTERNAL_CAMERA1);
//or you can select a Bluetooth camera like this
Symbol.Barcode2() MyReader = new Symbol.Barcode2(DEVICETYPES.BT_CAMERA1);
Enables the scanner hardware. This method does not make the scanner scan or turn on the laser.
Calling this method is optional.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
private void button_Click(object sender, EventArgs e)
{
if (!myBarcode.IsEnabled)
{
myBarcode.Enable();
}
}
Start status notification thread
This Cancels any pending asynchronous Scan() calls. (Will not work for buffered scans)
private void button1_Click(object sender, EventArgs e)
{
//Issues an Asynchronous scan that calls back to an event delegate when a trigger is pulled
Results result = myBarcode.Scan();
}
...
//Button to issue a cancel of the async scan
private void button2_Click(object sender, EventArgs e)
{
myBarcode.ScanCancel();
}
Returns the of the operation. Returns if there is a pending scan, and if there is no pending scan
Returns the number of pending ScanData objects in the buffer.
The number of pending ScanData Objects. -1 if Buffered scans have not been started.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//issue a start to buffered scans
Results result = myBarcode.ScanBufferStart();
}
...
//button to get a count of buffered scans
private void btnBufferCount_Click(object sender, EventArgs e)
{
int NumberOfScans = myBarcode.ScanBufferCount();
}
This clears all unread scans in the buffer.
Returns the of the operation. Returns if in buffered scan mode, and if it is not in buffered scan mode.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//issue a start to buffered scans
Results sd = myBarcode.ScanBufferStart();
}
...
//button to Clear buffered scans
private void btnBufferClear_Click(object sender, EventArgs e)
{
Results sd = myBarcode.ScanBufferClear();
}
Starts a Synchronous Scan. The method will not turn on the scanner.
It will, however, put the scanner in a state in which the scanner can be
turned on either by pressing a hardware trigger or by performing a software trigger.
This is a blocking call and the thread will be unresponsive until the timeout expires or
the data is read.
The time the scanner should wait for a trigger to be pulled (in milliseconds). Must be between 1000 milliseconds and 5 minutes (1 second to 5 minutes.)
A ScanData Object that contains the data from the barcode
ScanData myScanData;
private void btnScan_Click_1(object sender, EventArgs e)
{
myScanData = myBarcode.ScanWait(5000); // 5 second timeout
if (myScanData.Result == Results.SUCCESS)
{
if (myScanData.IsText)
{
TextBox2.Text = "ScanWait(): " + TextBox2.Text + "\r\n";
}
}
else if (myScanData.Result == Results.E_SCN_READTIMEOUT)
{
TextBox2.Text = "The Scan request has timed out."\r\n";
}
else
{
TextBox2.Text = "ScanWait() Unsuccessful\r\n" + myScanData.Result;
}
}
Starts an asynchronous Scan. The method will not turn on the scanner.
It will, however, put the scanner in a state in which the scanner can be
turned ON either by pressing a hardware trigger or can be turned ON automatically.
This is determined by the property.
An event handler needs to be attached in order to get the Scan Data in a callback.
This request can be cancelled by issuing a .
The of if the scan was successful or not.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//Issues an Asynchronous scan that will call back to the event delegate when a trigger is pulled.
//This is not a blocking call and the UI will still be responsive
Results sd = myBarcode.Scan();
}
...
void myBarcode_OnScan(ScanDataCollection sd)
{
if (rd.Result == Results.SUCCESS)
{
TextBox1.Text = TextBox1.Text + rd.Text + "\r\n";
}
else
{
TextBox1.Text = TextBox1.Text + "Read Unsuccessful\r\n" + rd.Result;
}
}
Starts an asynchronous Scan using an OnScan event delegate as a parameter.
The method will not turn on the scanner.
It will, however, put the scanner in a state in which the scanner can be
turned on either by pressing a hardware trigger or by performing a software trigger.
This request can be cancelled by issuing a . When using this method there
is no need to attach an OnScan event handler.
The event handler you want to handle the callback
The of if the scan was successful or not.
private void Form1_Load(object sender, EventArgs e)
{
//This is not a blocking call and the UI will still be responsive
Results sd = myBarcode.Scan(new Barcode2.OnScanHandler(myBarcode_OnScan1));
}
...
void myBarcode_OnScan1(ScanDataCollection sd)
{
if (sd.Length == 1)
{
ScanData rd = sd.GetFirst;
if (rd.Result == Results.SUCCESS)
{
TextBox1.Text = TextBox1.Text + rd.Text + "\n";
}
else
{
TextBox1.Text = TextBox1.Text + "Read Unsuccessful\n" + rd.Result;
}
}
}
Starts an asynchronous Scan. The method will not turn on the scanner.
It will, however, put the scanner in a state in which the scanner can be
turned on either by pressing a hardware trigger or by performing a software trigger.
An event handler needs to be attached in order to get the Scan sData in a callback.
This request can be cancelled by issuing a .
If the time period for the timeout period expires a Scandata object will be returned with the value E_SCN_READTIMEOUT in the Results field.
The time the scanner should wait for a trigger to be pulled (in milliseconds). Must be between 1000 milliseconds and 5 minutes (1 second to 5 minutes.)
The of if the scan was successful or not.
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
private void button8_Click(object sender, EventArgs e)
{
//Issues an Asynchronous scan that calls back to an event delegate when a trigger is pulled
// within the timeout passed
Results sd = myBarcode.Scan(5000);
}
...
void myBarcode_OnScan(ScanDataCollection sd)
{
if (sd.Length == 1)
{
ScanData rd = sd.GetFirst;
if (rd.Result == Results.SUCCESS)
{
TextBox1.Text = TextBox1.Text + rd.Text + "\r\n";
}
else
{
TextBox1.Text = TextBox1.Text + "Read Unsuccessful\r\n" + rd.Result;
}
}
}
Starts an asynchronous Buffered scan mode. The method will not turn on the scanner.
It will, however, put the scanner in a state in which the scanner can be
turned on either by pressing a hardware trigger or by performing a software trigger.
When scanning multiple barcodes, the user may want to continue scanning without waiting
for each OnScan callback to be validated or processed. In order to facilitate this,
an application can use the buffered-read mode. In this mode as soon as the application calls
the ScanBufferStart() function the user will be able to scan bar codes.
See note on 'Buffered Reads' in the programmer's guide for more information.
The of if the scan was successful or not.
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
Results sd = myBarcode.ScanBufferStart();
...
void myBarcode_OnScan(ScanDataCollection sd)
{
if (sd.Length == 1)
{
ScanData rd = sd.GetFirst;
if (rd.Result == Results.SUCCESS)
{
TextBox1.Text = TextBox1.Text + rd.Text + "\r\n";
}
else
{
TextBox1.Text = TextBox1.Text + "Read Unsuccessful\r\n" + rd.Result;
}
}
}
Directly gets buffered scanned data instead of using an OnScan callback. In order for this method
to work the barcode reader must be in buffered read mode and there may not be an event
handler attached. The maximum number of ScanData objects returned in the collection is
set in Config., the default is 1. It is
recommended to use an event handler to handle instead of using
this method.
, a collection of scan data objects
private void Form1_Load(object sender, EventArgs e)
{
Symbol.Barcode2 myBarcode = new Symbol.Barcode2();
Results result = myBarcode.ScanBufferStart();
}
...
private void button11_Click(object sender, EventArgs e)
{
ScanDataCollection data; //Create a collection of Scandata objects
data = myBarcode.GetScannedData(); // get all buffered scans from memory
//loop through the collection
foreach (ScanData sd in data)
{
if (sd.Result == Results.SUCCESS)
{
TextBox1.Text = TextBox1.Text + sd.Text + "\r\n";
}
else
{
TextBox1.Text = TextBox1.Text + "Scan Error\r\n";
}
}
}
Pauses buffered scan mode. It retains the state of the buffer and any unread data will not be lost.
Returns the of the operation. Returns if in buffered scan mode, and if it is not in buffered scan mode.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//start to buffered scans
Results sd = myBarcode.ScanBufferStart();
}
...
//button to issue a pause to buffered scans
private void btnBufferPause_Click(object sender, EventArgs e)
{
Results sd = myBarcode.ScanBufferPause();
}
Resumes buffered Scan Mode from a paused state.
Returns the of the operation. Returns if in buffered scan mode, and if it is not in buffered scan mode.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//issue a start to buffered scans
Results sd = myBarcode.ScanBufferStart();
}
...
//button to issue a pause to buffered scans
private void btnBufferPause_Click(object sender, EventArgs e)
{
Results sd = myBarcode.ScanBufferPause();
}
...
//button to issue a resume to paused buffered scans
private void btnBufferResume_Click(object sender, EventArgs e)
{
Results sd = myBarcode.ScanBufferResume();
}
Stops the buffered scan mode. After this method is executed any pending buffered reads will be lost.
Returns the of the operation. Returns if in buffered scan mode, and if it is not in buffered scan mode.
private void Form1_Load(object sender, EventArgs e)
{
//Attach an event handler to the barcode object
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
...
//issue a start to buffered scans
Results sd = myBarcode.ScanBufferStart();
}
...
//button to issue a stop to buffered scans
private void btnBufferStop_Click(object sender, EventArgs e)
{
Results sd = myBarcode.ScanBufferStop();
}
Disables the scanner. Any stored scan data will be lost.
NOTE: When calling Enable() after Disable(), all the latest configuration parameter values (Config.Decoders, Config.Scanner,
Config.Reader and Config.Interface) will be set automatically. If the parameters need to be reset to default values,
either Config.RestoreAllDefaultParameters() or RestoreDefaults() (for the correpsonding parameter) can be called.
if (myBarcode.IsEnabled)
{
myBarcode.Disable();
}
Frees up all resources used by the Barcode Reader, including any objects it has created.
It is necessary that this method be called when the Barcode Reader is no
longer needed by the application. This call will automatically diable the scanner too.
if (myBarcode != null)
{
myBarcode.Dispose();
}
Finalizer
Attach to this notification event to be called back when a scan event occurs.
This should be used with regular asynchronous scan's and Buffered scans.
A delegate of the method that will be invoked
when a scan event occurs.
//Create Barcode2 object and attach event handler
Barcode2 myBarcode = new Barcode2();
myBarcode.OnScan += new Barcode2.OnScanHandler(myBarcode_OnScan);
Results sd = myBarcode.Scan();
...
void myBarcode_OnScan(ScanDataCollection scancollection)
{
ScanData sd = scancollection.GetFirst;
if ((sd.Result == Results.SUCCESS) || (sd.Result == Results.E_SCN_BUFFERTOOSMALL))
{
textScan.Text += sd.Text + "\r\n";
}
}
Attach to this notification event to be called back when a status event occurs.
The status Callback will provide the object which provides , and .
private void Form1_Load(object sender, EventArgs e)
{
Barcode2 myBarcode = new Barcode2();
myBarcode.OnStatus += new Barcode2.OnStatusHandler(myBarcode_OnStatus);
}
...
void myBarcode_OnStatus(StatusData status)
{
txtBoxStatus.Text = status.EventType.ToString();
}
The Config property holds access to all the parameters inside the interface, scanner, reader and decoder objects.
Barcode reader version property.
This property provides access to the RSM
This property gets the device capabilities information for a scanner.
Returns if the scanner is enabled
Specifies whether or not there is currently in a pending scan situation.
-
True - After calling any of the scan methods such as Scan(), Scan(timeout), Scan(OnScanHandler), ScanBufferStart(), ScanBufferResume() and ScanWait(timeout)..
-
False - After the successful scan of a barcode or if the scan failed. It will also be set to false if any of these methods are called - ScanCancel(), Disable(), ScanBufferPause() and ScanBufferStop()
Delegate of the method that will be invoked when a scan event occurs.
ScanDataCollection
Delegate of the method that will be invoked when a status event occurs.
StatusData
This property gets the device capabilities information for a scanner.
Provides a list of supported beam widths. The beam width parameter for the laser scanner can be modified using the Barcode2.Config.Reader.ReaderSpecific.LaserSpecific.BeamWidth property.
The beam width feature is not supported on Imager scanners.
NOTE: All laser scanners support BEAM_WIDTH.NORMAL by default. This array can be used by the application to query any other beam widths it may support.
Flag telling if the device supports aiming.
Flag telling if the device supports scan direction reporting.
Flag telling if the device supports remote (non-local) feedback.
Flag describing whether this engine supports a video viewfinder.
Flag describing whether this engine supports adaptive scanning.
NOTE: The adaptive scanning feature can be enabled/disabled using the Barcode2.Config.Reader.ReaderSpecific.LaserSpecific.AdaptiveScanning property.
Refer to this property's help page for important information about the Adaptive Scanning feature.
Maximum image cropping rectangle (pixels). This is the maximum image resolution that can be expected.
If the image capture is not supported, this will all be zeros.
Flag describing whether engine is capable of decoding DPM bar codes.
Bit mask of supported image formats. See IMAGE_FORMAT for a list of supported formats.
Indicates support of Document Capture for a scanner.
Draws a rectangle.
Gets or sets the distance, in pixels, between the left edge of the rectangle and the left edge of its container's client area.
Gets or sets the distance, in pixels, between the top edge of the rectangle and the top edge of its container's client area.
Gets the distance, in pixels, between the right edge of the rectangle and the left edge of its container's client area.
Gets the distance, in pixels, between the bottom edge of the rectangle and the top edge of its rectangle's client area.
ScanData class encapsulates all the scanned data and meta-data for a given read.
Returns the scanned data text.
A string of the scanned data if the memory buffer has been set to text mode.
An
InvalidDataTypeException is thrown if this property is accessed and they
memory buffer has been set to binary mode.
ScanData constructor.
ScanData constructor with ScanDataFormats and ReaderDataLengths.
ScanData constructor with ScanDataFormats and int.
Reset the contents of a Scandata object
Finalizer
Frees up all resources used by the ScanData object.
The length of the barcode data.
An integer that specifies the length of the scanned data.
Specifies whether or not the ScanData memory buffer is set to text mode.
A boolean flag which when true indicates that the memory buffer is set to
text mode, otherwise the memory buffer is set to binary mode.
Specifies whether or not a memory buffer has been allocated for the ScanData.
A boolean flag which when true indicates that a valid memory buffer has been
allocated, otherwise the memory buffer has not been allocated.
Specifies the memory buffer size allocated by the ScanData.
An integer which specifies the memory buffer size in bytes for binary mode or
characters for text mode.
Returns the scanned data text.
A string of the scanned data if the memory buffer has been set to text mode.
An InvalidDataTypeException
is thrown if this property is accessed and they memory buffer has been set
to binary mode.
The Decoder Type of the barcode in hexadecimal format.
A string of the form "0x#", where # is the decoder type in hexadecimal.
Returns a byte array with the scanned data.
A byte array with the scanned data if the ScanDataFormat has been set to binary mode.
An InvalidDataTypeException
is thrown if this property is accessed and ScanDataFormat has been set
to text mode in the constructor of ScanData object.
Returns the source of the scanned data. (ie The barcode scanner device name)
A string that contains the name of the scanner which provided the source.
The time at which the barcode was scanned.
A DateTime structure that contains the time information.
The Decoder type of the barcode.
A member that specifies the type of barcode scanned.
The flag indicating whether the data is in the multi-part format.
If this has been set to true, the user is supposed to get the auxiliary data.
Note: The usage of this has been deprecated. Instead, the usage of the property AuxDataFormat has been recommended.
AuxDataFormat denotes whether the auxiliary data is available or not.
In case of auxiliary data being available, AuxDataFormat will denote the type of auxiliary data as well (The multipacket composite barcode data, the image data, or unknown).
Provides the access to the auxiliary data.
The availability of auxiliary data can be determined by checking the AuxData.AuxDataFormat property.
The auxiliary data will be populated in case of some composite barcodes and for document capture.
In case of auxiliary data being available, AuxData.AuxDataFormat will denote the type of auxiliary data as well (The multipacket composite barcode data, the image data, or unknown).
void myBarcode2_OnScan(ScanDataCollection scancollection)
{
foreach (ScanData scanData in scancollection)
{
// The availability of auxillary data is first determined
if (scanData.AuxDataFormat != AUX_FORMATS.NO_DATA)
{
// In case of composite barcodes, AuxDataFormat will be set to AUX_FORMATS.BARCODE_DATA on successful decode
if (scanData.AuxDataFormat == AUX_FORMATS.BARCODE_DATA)
{
barcodeAuxDataTextBox.Text = scanData.AuxData.Text;
//The raw composite data is available through scanData.AuxData.RawData
}
// In case of document capture, AuxDataFormat will be set to AUX_FORMATS.IMAGE_DATA on successful decode
else if (scanData.AuxDataFormat == AUX_FORMATS.IMAGE_DATA)
{
scanData.AuxData.GetBitmap().Save("Test.jpg", System.Drawing.Imaging.ImageFormat.Jpeg);
//The byte data for the image is available as MemoryStream through scanData.AuxData.scanData.AuxData.ImageStream
}
}
}
}
The ID of the read submitted to the barcode scanner hardware.
An integer that represents the ID of the requested read.
The result of the read request.
This result is a managed code version of the actual result returned by the
underlying scan driver stack. It can be used to determine whether or not the
read was successful or failed.
A member that indicates whether or not the read was
successful.
Data types for the data that is read from barcode scanner.
Length of ScanData memory buffer.
Format of the data in auxiliary data buffer.
The usage of this has been recommended over the usage of the property MultiPart.
This property AuxDataFormat denotes whether the auxiliary data is available or not.
In case of auxiliary data being available, this will denote the type of auxiliary data as well (The multipacket composite barcode data, the image data, or unknown).
Provides the access to the auxiliary data. This is meant to be used in conjunction with a ScanData instance.
Returns the auxiliary data text.
A string of the auxiliary data if the ScanData memory buffer has been set to text mode.
An
InvalidDataTypeException is thrown if this property is accessed and the ScanData
memory buffer has been set to binary mode.
Returns the bitmap of the image in auxiliary data buffer.
Only valid for AUX_FORMATS.IMAGE_DATA.
Returns the auxiliary data text.
A string of the auxiliary data if the ScanData memory buffer has been set to text mode.
Only valid for AUX_FORMATS.BARCODE_DATA.
An
InvalidDataTypeException is thrown if this property is accessed and the ScanData
memory buffer has been set to binary mode.
Returns a byte array of the auxiliary data.
A byte array of the auxiliary data if the ScanData memory buffer has been set to binary mode.
Only valid for AUX_FORMATS.BARCODE_DATA and AUX_FORMATS.UNKNOWN.
An InvalidDataTypeException
is thrown if this property is accessed and ScanDataFormat has been set
to text mode in the constructor of ScanData object.
The length of the auxiliary data, in bytes.
This is valid for all formats of auxiliary data.
Will be the length of RawData for the formats AUX_FORMATS.BARCODE_DATA and AUX_FORMATS.UNKNOWN.
Will be the length of ImageStream in case of AUX_FORMATS.IMAGE_DATA.
The memory stream of the image data in auxiliary data buffer.
Only valid for AUX_FORMATS.IMAGE_DATA.
This memory stream won't contain the type, the height and the width of the image.
They would be given separately by the 3 properties ImageFormat, ImageHeight and ImageWidth.
The format of the image in auxiliary data buffer.
Only valid for AUX_FORMATS.IMAGE_DATA.
The height of the image in auxiliary data buffer.
Only valid for AUX_FORMATS.IMAGE_DATA.
The width of the image in auxiliary data buffer.
Only valid for AUX_FORMATS.IMAGE_DATA.
The StatusData class provides access to notification information.
Retrieves the Barcode Reader event type.
Retrieves the Barcode Reader event state.
Retrieves the Doc Capture state.
Retrieves the Barcode Reader state in string form.
This Object is a IEnumerable collection of ScanData Objects used to store multiple scans
Constructor to instantiate ScanDataCollection object
Clear all contents in the collection
Clone the collection
An object
Add a new ScanData object to the collection
Remove a ScanData object from the collection
position to remove scandata object from
Returns an enumerator that iterates through the ScanData collection.
ScanData collection
Returns the size of the collection.
Returns the first ScanData object in the collection
Returns the Current Scandata object in the collection
A native SendMessage Win32 call. Used in the notification process.
The handle to a window.
The windows message.
WParam
LParam
Return value.
UnimplementedFunctionException is thrown when a method is
not available for use.
Derived off of the System.Exception class, this exception provides
no additional functionality over its derived class.
UnimplementedFunctionException constructor with settable
string.
A string the contain information about
the exception.
WrongMarshalSizeException is thrown when marshalling fails to work
correctly. In particular, when a size of the marshaled buffer is not the
correct size.
Derived off of the System.Exception class, this exception provides
no additional functionality over its derived class.
WrongMarshalSizeException constructor with settable
string.
A string the contain information about
the exception.
OperationFailureException is thrown when a failure occurs in the
class libraries. This failure usually is one that stops the proper
functioning of the class libraries.
Derived off of the System.Exception class, this exception provides
a results enum or integer to be associated with the exception. The
number is returned in integer form via the Result property.
OperationFailureException constructor with settable string and
results enum.
A string the contains information about
the exception.
A Results enumerated type that contains
information about the exception.
OperationFailureException constructor with settable string and
integer value.
A string the contains information about
the exception.
A integer that contains information about
the exception.
The number associated with the exception.
An integer result that contains information about what caused the
exception.
InvalidUsageException is thrown when a class library method or property
is not used correctly.
Derived off of the System.Exception class, this exception provides
no additional functionality over its derived class.
Default InvalidUsageException constructor.
InvalidUsageException constructor with settable string.
A string that contains information about
the exception.
InvalidDataTypeException is thrown when a class library accesses an
invalid data type.
Derived off of the class,
this exception provides no additional functionality over its
derived class.
Default InvalidDataTypeException constructor.
InvalidDataTypeException constructor with settable string.
A string that contains information about
the exception.
InvalidRequestException is thrown when a class library trys to perform
an invalid request.
Derived off of the class,
this exception provides no additional functionality over its
derived class.
Default InvalidRequestException constructor.
InvalidRequestException constructor with settable string.
A string that contains information about
the exception.
InvalidIndexerException is thrown when a class library trys to access
an invalid indexer.
Derived off of the class,
this exception provides no additional functionality over its
derived class.
Default InvalidIndexerException constructor.
InvalidIndexerException constructor with settable string.
A string that contains information about
the exception.
DebugModeException is thrown when a class library trys to perform
functions that are invalid but not fatal.
Derived off of the System.Exception class, this exception provides
the capability of associated the exception with an integer.
DebugModeException constructor with settable string and integer
information.
A string that contains information about
the exception.
An integer that contains information about
the exception.
The number associated with the exception.
An integer result that contains information about what caused the
exception.
DebugModeUnsupportedEnumValue is thrown when a class library trys to
access an enumerated type that is not valid.
Derived off of the class, this
exception provides no additional functionality.
DebugModeUnsupportedEnumValue constructor with settable string and integer
information.
A string that contains information about
the exception.
An integer that contains information about
the exception.
The Devices class provides information about all the available scanners in the system.
The SupportedDevices property can be used to obtain a list of all available hardware for use with the barcode classes.
The Device class provides information about a specific scanner in the system.
Provides read/write access to the device name of the device.
A string that contains the device name.
Provides read/write access to the friendly name of the device.
A string that contains the friendly name.
Provides read/write access to the portname of the device.
A string that contains the portname.
The type of scanning device.
The class for the RemoteScanner API. It provides the list of RSM attributes.
An object of this class gets created by the Barcode object automatically.
Application should not attempt to instantiate an object of this class.
NOTE: The RSM feature can only be used when using remote scanner devices such as RS507.
Provides Beep and/or LED feedback on the remote scanner.
This feature is available only on remote scanners with feedback capabilites like RS507. To determine if this feature is available check the property in the Barcode2.DeviceInfo object.
The Config class for the RSM (Remote Scanner Management). It provides access to list of RSM config parameters. Application should not attempt to instantiate an object of this class. NOTE: The RSM feature can only be used when using remote scanner devices such as RS507.
The RemoteScannerConfig class for the RSM (Remote Scanner Management). It provides access to list of RSM config parameters. Application should not attempt to instantiate an object of this class. NOTE: The RSM feature can only be used when using remote scanner devices such as RS507.
The constructor.
The RemoteFeedback property provides access to feedback parameters.
Provides a list of supported attributes.
Provides access to model number. The maximum length of the attribute value is 18.
Provides access to serial number. The maximum length of the attribute value is 16.
NOTE: Only current value is relevant for this attribute.
Provides access to date of scanner device manufacture. The maximum length of the attribute value is 7.
NOTE: Only current value is relevant for this attribute.
Provides access to date of last repair done at a Motorola authorized repair facility. The maximum length of the attribute value is 7.
Provides access to unique Bluetooth address. The length of the byte array value of the attribute is 6 bytes.
NOTE: Only current value is relevant for this attribute.
Provides access to the status of Bluetooth Authetication.
Provides access to the status of Bluetooth encryption.
Provides access to the PIN code of the Bluetooth device when Bluetooth authentication is enabled.
The PIN code is permanently saved. The maximum length of the attribute value is 5.
The default PIN stored in memory is “12345”.
Provides access to the reconnect attempts parameter of the scanner device.
Provides access to the beeps when reconnect attempts is made.
Provides access to the HID reconnection parameter.
Provides access to the friendly name of the Bluetooth device. The maximum length of the attribute value is 23.
NOTE: Only current value is relevant for this attribute.
Provides access to the type of PIN code to use for the Bluetooth device. This attribute is not saved permanently on the Bluetooth device.
Provides access to the inquiry mode of the Bluetooth device.
Provides access to the mems feature.
Provides access to the proximity feature.
Provides access to the proximity distance.
Provides access to the paging feature.
Provides access to the paging beep sequence.
Provides access to the low battery indicator.
Provides access to the trigger wakeup feature.
Provides access to the automatic reconnect feature of the Bluetooth device.
Provides access to the low battery indication cycle.
Provides access to the preferred Bluetoothwireless host.
NOTE: PreferredWirelessHost attribute is not supported. Therefore, this property and its corresponding class "PreferredWirelessHost" will be deprecated in future releases.
Provides access to the paging activation command.
Provides access to the firmware version. The maximum length of the attribute value is 18.
NOTE: Only current value is relevant for this attribute.
Provides access to the device class of the system. The maximum length of the attribute value is 18.
Provides access to the battery status.
Provides access to the battery capacity.
Provides access to the battery ID.
Provides access to the hardware version.
NOTE: HardwareVersion attribute will not be supported in the future. Therefore, this property and its corresponding class "HardwareVersion" will be deprecated in future releases.
Provides access to the pick list mode.
Provides access to the Bluetooth disconnect command.
Provides access to the Bluetooth unpair command.
Provides access to the delay between proximity continuous good scans.
Provides access to the proximity continuous feature.
Provides access to the feature for ignoring Code 128’s beginning with 420 and 421
Provides access to disable the good decode Green LED and beep on scanner
Provides access to the feature to save the Bluetooth address when pairing fails. This attribute is permanently saved.
Provides access to the battery capacity.
The base class for providing access to the RSM (Remote Scanner Management) attributes.
The constructor.
Returns whether or not the RSM attribute is supported by the scanner device.
Returns the unique number of the RSM attribute.
Returns the type of the RSM attribute.
Provides the current value of the attribute.
Capacity of the Battery:
0-100 (in percent)
9999 if error (i.e. try to get capacity when no battery)
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the battery ID.
Provides the current value of the attribute.
Battery ID:
0 – Simple
1 – Double
2 – Cabled
9999 – Error
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the battery status.
Provides the current value of the attribute.
Indicates the status of Battery in the device:
0- unknown
1- Full
2- Medium
3- Empty
4- Charging – full rate
5- Charging – half rate
6- Charging – Trickle
7- Discharging – Battery Cycle in progress
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the beeps when reconnect attempts is made.
Provides the current value of the attribute.
When this attribute is enabled, the scanner will emit 5 short high beeps every 5 seconds
while the reconnection attempt is in progress.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to unique Bluetooth address. The length of the byte array value of the attribute is 6 bytes.
NOTE: Only current value is relevant for this attribute.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides the raw (as byte array) current value of the attribute as received from the driver. The length of the byte array is 6 bytes.
Provides the raw (as byte array) factory default value of the attribute as received from the driver. The length of the byte array is 6 bytes.
Provides the raw (as byte array) custom default value of the attribute as received from the driver. The length of the byte array is 6 bytes.
Returns the subtype of the attribute.
Provides access to the status of Bluetooth Authetication.
Provides the current value of the attribute.
True if the Bluetooth authentication is required.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the automatic reconnect feature of the Bluetooth device.
Provides the current value of the attribute.
Defines Bluetooth reconnection scheme:
0 –None
1 - On Power
2 - On Out Of Range
3 - On Power Out Of Range
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the Bluetooth disconnect command
Command the scanner to disconnect from mobile computer.
0 - disconnect
NOTE: Since this property is used for issuing a command, this is a set-only property.
Provides access to the status of Bluetooth encryption.
Provides the current value of the attribute.
True if the encryption over Bluetooth is required.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the friendly name of the Bluetooth device. The maximum length of the attribute value is 23.
NOTE: Only current value is relevant for this attribute.
Provides the current value of the attribute.
Friendly name displayed by Bluetooth remote devices (Permanently saved).
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the inquiry mode of the Bluetooth device.
Provides the current value of the attribute.
True for using the limited Inquiry mode
False for using the general inquiry mode
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the PIN code of the Bluetooth device when Bluetooth authentication is enabled.
The PIN code is permanently saved. The maximum length of the attribute value is 5.
The default PIN stored in memory is “12345”.
Provides the current value of the attribute.
Pincode used when the Bluetooth Authentication is enabled (Permanently saved).
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the Bluetooth unpair command
Commands scanner to unpair from mobile computer
0 - unpair
NOTE: Since this property is used for issuing a command, this is a set-only property.
Provides access to date of scanner device manufacture. The maximum length of the attribute value is 7.
NOTE: Only current value is relevant for this attribute.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to date of last repair done at a Motorola authorized repair facility. The maximum length of the attribute value is 7.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the device class of the system. The maximum length of the attribute value is 18.
Provides the current value of the attribute.
The device class of the system.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to disable the good decode Green LED and beep on scanner
Provides the current value of the attribute.
True - Disables the good decode Green LED and beep on scanner
False - Enables the good decode Green LED and beep on scanner
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the feature for ignoring Code 128’s beginning with 420 and 421
Provides the current value of the attribute.
Enable/Disable the feature for ignoring Code 128’s beginning with 420 and 421
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the firmware version. The maximum length of the attribute value is 18.
NOTE: Only current value is relevant for this attribute.
Provides the current value of the attribute.
Scanner’s operating system version.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the feature to save the Bluetooth address
when pairing fails. This attribute is permanently saved.
Provides the current value of the attribute.
True - Saves Bluetooth address when pairing fails
False - Does not save Bluetooth address when pairing fails
This attribute is saved permanently.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the delay between proximity continuous good scans.
Provides the current value of the attribute.
Defines the delay between proximity continuous good scans in msec.
Values are betwwen 0 and 150 (* 100 msec)
0 – No delay
1 – 100 msec
2 – 200 msec
..
..
150 – 15000 msec
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the hardware version.
NOTE: HardwareVersion attribute will not be supported in the future. Therefore, this class will be deprecated in future releases.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the HID reconnection parameter.
Provides the current value of the attribute.
Auto-reconnect behavior of the scanner when HID connection is lost.
0 - Never Reconnect
1 - Reconnect on Data
2 - Reconnect Immediately
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the low battery indication cycle.
Provides the current value of the attribute.
Low battery indication cycle time in seconds.
Use the value:
0 for 15 secs cycle
1 for 30 secs cycle
2 for 60 secs cycle
3 for 90 secs cycle
4 for 120 secs cycle
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the low battery indicator.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the mems feature.
Provides the current value of the attribute.
Enable/Disable mems feature
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to model number. The maximum length of the attribute value is 18.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the paging activation command.
Start /Stop paging to scanner
0 – stop
1 – start
NOTE: Since this property is used for issuing a command, this is a set-only property.
Provides access to the paging beep sequence.
Provides the current value of the attribute.
Paging beep sequence
Beep pattern values: 0-15
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the paging feature.
Provides the current value of the attribute.
Enable/disable paging
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the type of PIN code to use for the Bluetooth device. This attribute is not saved permanently on the Bluetooth device.
Provides the current value of the attribute.
False – (default) Use PIN code stored in memory of Bluetooth device. The default PIN stored in memory is “12345”.
True – Prompt the user to scan a new PIN code using the Bluetooth device.
This attribute is not saved permanently on the Bluetooth device.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the preferred Bluetoothwireless host.
NOTE: PreferredWirelessHost attribute is not supported. Therefore, this class will be deprecated in future releases.
Provides the current value of the attribute.
Preferred Bluetooth wireless host:
18 – Scan
19 – Spp
20 – Hid
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the proximity continuous feature.
Provides the current value of the attribute.
Enable/disable proximity continuous feature.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the proximity distance.
Provides the current value of the attribute.
Proximity distance:
0 – Short
1 – Mid
2 – Long
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the proximity feature.
Provides the current value of the attribute.
Enable/disable proximity
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the reconnect attempts parameter of the scanner device.
Provides the current value of the attribute.
Indicates the time duration during which the scanner tries to reestablish the connection, when it goes out of range.
Use the value:
6 for 30 secs duration
7 for 35 secs duration
8 for 40 secs duration
9 for 45 secs duration
10 for 50 secs duration
11 for 55 secs duration
12 for 60 secs duration
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the pick list mode.
Provides the current value of the attribute.
Enables or disables the Pick list mode.
0 – Disable
2 – Enable
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to the trigger wakeup feature.
Provides the current value of the attribute.
True - Scan trigger serves as device wakeup source from low power
False - Scan trigger does NOT serve as device wakeup source from low power
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
Provides access to serial number. The maximum length of the attribute value is 16.
NOTE: Only current value is relevant for this attribute.
Provides the current value of the attribute.
Provides the factory default value of the attribute.
Provides the custom default value of the attribute.
This class provides access to the feedback parameters on the remote scanner. NOTE: The Remote feedback feature is available only on remote scanners with feedback capabilites like RS507. To determine if this feature is available check the property in the Barcode2.DeviceInfo object.
Constructor
A value of zero (0) indicates no beep and a value is greater then zero (>0) enables the beep.
Provides the beep frequency.
Provides the LED time duration in milliseconds.
A value of zero (0) indicates no LED used in feedback.
Provides the path of a wave file.
NOTE: This property is reserved for future use. So please do not use this property currently.
Provides the pattern of the beep.
Provides the pattern of the LED.
Convert to System.DateTime
Indicates support of Document Capture for a scanner.
Document Capture is not supported.
Document Capture 1.0 is supported.
This version of Document Capture supports only Auto Trigger Mode.
Document Capture 1.0 and Document Capture 2.0 are supported.
This version of Document Capture supports Auto Trigger Mode and User Trigger Mode.
Advanced Edge Detection is supported with User Trigger Mode.
Document Capture related status reporting is supported with User Trigger Mode.
Describes the status of the Document capture using mode.
This field is not used/supported in the selected trigger mode.
Scanner(Camera/Imager) is ready to scan/capture. Waiting for trigger press.
Trigger is pressed and scanner(Camera/Imager) is displaying images through viewfinder for preview.
Trigger is released and scanner(Camera/Imager) is taking picture for processing.
Analyzing image which is captured on the trigger release. Result is awaited.
Finished analyzing the image which was captured on the trigger release. Image is good and final (cropped) image and/or barcode data would be available soon
Image which was captured on trigger released is rejected.
Image which was captured on trigger released is processed and final image after processing is available in buffer.
An error has occurred. Look for ScanError for details.
Enumerated ISBT128 concatenation modes.
Will ignore the barcode pair and only output decode data for only one of the barcodes
Will not decode if both the barcodes are not present or if one of them cannot be decoded
Auto-discriminate
The class for representing a rectangle with Left, Top, Right and Bottom coordinates.
x-coordinate of the upper-left corner.
y-coordinate of the upper-left corner.
x-coordinate of the bottom-right corner.
y-coordinate of the bottom-right corner.
The constructor. All the members are initialized to 0s.
x-coordinate of the upper-left corner.
y-coordinate of the upper-left corner.
x-coordinate of the bottom-right corner.
y-coordinate of the bottom-right corner.
Describes the linear security level used during decoding.
Two times redundancy based on the redundancy flags and the code length; This is not a valid setting for the imager barcode readers.
Two times redundancy if short bar code or CODABAR.
Two times redundancy for all bar codes.
Two times redundancy for long bar codes, three times for short bar codes.
Three times redundancy for all bar codes.
Describes what type of DBP (Digital Bar Pulse) is being produced by the scan engine.
Tells the engine to produce normal DBP.
Tells the engine to produce composite DBP, which is 2 different sets of DBP data multiplexed together for better decode performance.
Focus mode to use.
Fixed focus.
Auto focus.
Focus position to use.
Far focus.
Near focus.
Direct Part Marking (DPM) mode to use.
Enable decoding of DPM bar codes
Disable decoding of DPM barcodes
Illumination mode to use
In this mode, the auto exposure algorithms will decide whether illumination is required or not.
In this mode, external illumination is always off.
In this mode, external illumination is always on.
Enumerates the different picklist modes.
Disables picklist mode, so any bar code within the field of view can be decoded.
Enables picklist mode so that only the barcode under the projected reticle can be decoded.
If the imager does not support a projected reticle then the behavior is same as that of PICKLIST_SOFTWARE_RETICLE.
Enables the picklist mode so that only the barcode in the center of the image is decoded.
This is most useful when used in conjunction with the static and dynamic reticle viewfinder modes.
Imager Specific Viewfinder Modes
Viewfinder disabled. Viewfinder is not displayed during aiming or scanning.
Viewfinder enabled. Displays the images captured by the camera on the screen.
Viewfinder enabled with locate reticle. Displays the viewfinder as well as draws a red reticle
in the center of the screen which helps with tracking the barcode.
Viewfinder enabled with dynamic reticle. Displays the viewfinder as well as draws a red reticle
in the center of the image. If the barcode in the image is ‘decodable’ the reticle turns green to indicate this.
Imager Specific Viewfinder Feedback Modes
Viewfinder feedback disabled. This mode disables any visual feedback on a successful decode.
Viewfinder feedback enabled. This mode displays the last image that successfully decoded.
The duration for which the image is displayed can be set by the VFFeedbackTime.
Viewfinder enabled with decode reticle. This mode displays the last image that successfully decoded
and also draws a reticle in the center of the image.
Enumerated inverse iD modes.
Disables decoding of inverse 1D symbologies.
Enables decoding of only inverse 1D symbologies.
Allows decoding of both positive as well as inverse 1D symbologies.
Enumerates the supported interface types.
QSNAC Interface
SSI Interface
LS48XX Interface
Lighthouse Interface
Camscan Interface
Size of the allocated structure, in bytes.
Amount of memory the structure actually uses, in bytes.
List of supported trigger modes
Hard trigger. When this mode is set, the user has to manually press the trigger on the device.
It is applicable to synchronous, asynchronous and buffered scans.
Soft trigger is used only once for a pending scan or for the next issued scan. When this mode is set, the scan beam will come up
automatically without having to press the trigger on the device.
It is applicable to synchronous, asynchronous and buffered scans.
Soft trigger is used for all pending scans and for future scans issued. When this mode is set, the scan beam will come up automatically without having to press the trigger on the device.
It is applicable to synchronous, asynchronous and buffered scans.
List of supported device types.
Internal Laser
Internal Imager
Internal Camera
Bluetooth Laser
Bluetooth Imager
Bluetooth Camera
Serial Laser
Serial Imager
Serial Camera
First Available Scanner
Unknown Scanner
The LABELTYPE data type defines a type of bar code label that can be returned from a
successful read request. Each label type can be decoded by one or more DECODERs.
Note: This enum is unused in the Symbol.Barcode2 API, hence it has been deprecated.
The UPC-E0 symbology.
The UPC-E1 symbology.
The UPC-A symbology.
The MSI symbology.
The EAN-8 symbology.
The EAN-13 symbology.
The CODABAR symbology.
The CODE-39 symbology.
The Discrete 2 of 5 symbology.
The Interleaved 2 of 5 symbology.
The CODE-11 symbology.
The CODE-93 symbology.
The CODE-128 symbology.
The IATA 2 of 5 symbology.
The EAN-128 symbology.
The PDF 417 symbology.
The ISBT 128 symbology.
The TRIOPTIC 3 of 9 symbology.
The COUPON CODE symbology.
The BOOKLAND EAN symbology.
The MICRO PDF symbology.
The CODE-32 symbology.
The MACRO PDF symbology.
The MAXICODE symbology.
The DATAMATRIX symbology.
The QRCODE symbology.
The MACRO MICRO PDF symbology.
The RSS-14 symbology.
The RSS limited symbology.
The RSS expanded symbology.
Image label type.
Signature label type.
The Scanlet WEBCODE symbology.
The CUE CAT CODE symbology.
The COMPOSITE AB symbology.
The COMPOSITE C symbology.
The TCIF Linked CODE 39 symbology.
The US POSTNET symbology.
The US PLANET symbology.
The UK POSTAL symbology.
The JAPANESE POSTAL symbology.
The AUSTRALIAN POSTAL symbology.
The DUTCH POSTAL symbology.
The CANADIAN POSTAL symbology.
The CHINESE_2OF5 symbology.
The AZTEC symbology.
The MICROQR symbology.
Korean 3 of 5 symbology.
US4State Symbology.
US4STATE_FICS Symbology.
The symbology or labeltype is unknown.
List of supported scanner types.
Laser
Imager
Camera
Unknown
List of supported transport types used by scanners.
Internal transport
Serial based SSI transport
Bluetooth based SSI transport
Unknown transport
Base registry key handles.
ID for creating a handler to Classes Root section in registry.
ID for creating a handler to Current User section in registry.
ID for creating a handler to Local Machine section in registry.
ID for creating a handler to Users section in registry.
The type of scan requests.
Foreground reads take priorty over background reads. When submitting
a foreground read the application should be the topmost window.
Background reads can be superceded by foreground reads. Background reads
are usually submitted by background applications such as a scan wedge program.
Monitor reads provide a way in which programs can listen in on all scans
that take place.
Supported feedback types
Provides remote feedback if scanner supports it
Provides local feedback only. Default value
Provides local as well as remote feedback
Describes the type of Code ID to be reported.
The (legacy) Symbol Technologies Inc.
CodeIDs are documented in the following table:
Code Type
Symbol Tech. Identifier
- UPC-A, UPC-E, UPC-E1, UPC-E0, EAN-13, EAN-8
A
- Code 39, Code 39 Full ASCII, Code 32
B
- Codabar
C
- Code 128, ISBT 128
D
- Code 93
E
- Interleaved 2 of 5
F
- Discrete 2 of 5, D 2 of 5 IATA
G
- MSI Plessey
J
- UCC/EAN 128
K
- Bookland EAN
L
- Trioptic Code 39
M
- UPC/EAN Coupon Code
N
- PDF417
X
- Data Matrix
P00
- QR Code, MicroQR
P01
- Maxicode
P02
- US Postnet
P03
- US Planet
P04
- Japan Postal
P05
- UK Postal
P06
- Australian Postal
P09
- Signature Capture
P0X
No Code ID.
Use (legacy) Symbol Technologies Code ID.
Use AIM Code ID.
Enumeration used to set the state of local feedback.
When Disabled, feedback is only done on the scanner device.
When Enabled, feedback is given locally. (e.g. at the Reader)
The UPC/EAN security level.
This setting allows the digital scanner to operate in its most aggressive state, while providing sufficient security in decoding most “in-spec” bar codes.
This default setting eliminates most misdecodes.
Select this option if Security level 1 fails to eliminate misdecodes.
If you selected Security Level 2 and misdecodes still occur, select this security level.
Be advised that selecting UPCEAN_SECURITY_LEVEL3 is an extreme measure against mis-decoding severely out of spec bar codes. Selecting this level of security significantly impairs the decoding ability of the digital scanner. Using improved quality of barcodes is preferable to using this level of security.
The type of supplemental mode.
Supplementals ignored.
Will not decode UPC/EAN without supplementals.
Auto-discriminates supplementals.
Enables smart supplementals. In this mode the decoder will return the
decoded value of the main block right away if it does not belong to one of
the following supplemental types: 378, 379, 977, 978, 979, 414, 419, 434, 439.
If the barcode starts with one of the prefixes it will search the image more
aggressively for a supplemental.
Enables (auto-discriminate) supplemental for UPC/EAN codes starting with 378
or 379. Will disable reading of supplementals for any other UPC/EAN barcode not starting with 378/379.
Enables (auto-discriminate) supplemental for UPC/EAN codes starting with 978
or 979. Will disable reading of supplementals for another UPC/EAN barcode not starting with 978/979.
Enables (auto-discriminate) supplemental for UPC/EAN codes starting with 977.
Will disable reading of supplementals for another UPC/EAN barcode not starting with 977.
Enables (auto-discriminate) supplemental for UPC/EAN codes starting
with 414, 419, 434 or 439. Will disable reading of supplementals for
another UPC/EAN barcode not starting with 414/419/434/439.
Lists the Bookland formats
978 reported in 10 digit mode
978/979 transmitted as EAN13 as per 2007 ISBN-13 protocol
Enumerated type that maps its members to underlying C API return codes.
The task was successful.
The task was cancelled.
The device is not enabled.
A Scanner error occurred opening the active driver registry key.
A Scanner error occurred reading the active driver registry key.
A Scanner error occurred opening the registry key containing the driver's settings.
A Scanner error occurred reading the registry key containing the driver's settings.
An attempt to allocate memory for scanner failed.
An invalid scanner device context ID was used.
An attempt was made to access an invalid scanner open context.
The scanner driver was accessed before a successful initialization.
The physical device driver (PDD) for scanner could not be loaded.
The physical device driver (PDD) DLL for scanner did not contain the required entry points.
Required scanner device is not present, already in use or not functioning properly.
The scanner device could not be started.
The default scanner parameters could not be obtained from the physical device driver (PDD).
An attempt was made to use or stop the scanner device and it was not started.
An attempt was made to start the scanner device when the device was already started.
An attempt was made to access the scanner device and it was not enabled.
An attempt was made to enable scanning when scanning was already enabled.
The control code passed to DeviceIoControl of the scanner is invalid.
A NULL pointer was passed for a required argument.
A passed argument is out of range.
The size of the buffer passed as an input to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwUsed.
The size of the buffer passed as an output to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwAllocated.
A STRUCT_INFO structure field is invalid. Either dwAllocated or dwUsed is less than the size of STRUCT_INFO or dwUsed is greater than dwAllocated.
The size of a structure specified in a StructInfo is too small to contain a required field.
An invalid handle was passed to a function.
The value of a parameter either passed as an argument to a function or as a member of a structure is out of range or conflicts with other parameters.
Unable to create a required event.
Unable to create a required thread.
A read request was cancelled.
A read request timed out.
Attempt to cancel a read that is not pending.
The task is pending.
NOTE: This enum entry is being deprecated. Use E_SCN_READPENDING instead. It will be removed in a future release.
Attempt to start a read when one is pending.
Data buffer is too small for incoming data.
Attempt to access fields of an invalid scan buffer.
Attempt to submit a read that is incompatible with reads already queued.
Attempt to perform physical device driver (PDD) feedback with no feedback capabilities.
Version of function not supported (e.g. ANSI vs. UNICODE).
The requested operation is inconsistent with the current state of the device.
No more items are available to be returned from SCAN_FindFirst/SCAN_FindNext.
A required registry key could not be opened.
A required registry value could not be read.
An exception occurred while trying to call the scanner driver.
A scanner API function failed with a non-scanner API error code. Call GetLastError to get extended error code.
A requested scanner resource is already in use.
The specified scanner resource was not allocated.
The specified decoder DLL can not be loaded.
At least one API is missing in Decoder DLL.
The symbol's format is invalid.
The platform does not have a valid license key.
The scanned macro symbol is not part of the current macro sequence.
The scanned macro symbol has already been scanned into the current macro sequence.
The Image HAL DLL can not be loaded.
At least one API function is missing in Image HAL DLL.
The Image Compression DLL can not be loaded.
I2C communication failed.
Camera security policy not allowing to use camera.
The specific RSM attribute number is not valid on scanner.
Invalid response received from scanner.
Missing configuration details.
Timeout used is invalid or out of acceptable range.
Cannot execute command due to buffered scanning has not being started.
Failure in creating the event.
Barcode2.Disable() method is in progress.
Options class provides the capability of setting parameters that effect that
way in which the EMDK for .NET class libraries work.
The Options class can be used to select how the class libraries should handle
errors that are not necessarilly fatal, but may be useful to customer during
development.
Turn on/off debug mode exceptions.
A boolean flag that when set to true enables exceptions to be thrown in
situations that are not fatal but may lead flag issues that should be
addressed prior to an application's release.
A helper class that provides a way in which applications can determine how long
tasks are taking.
This class is not as accurate as a Performance Counter. It should be used for
rough estimations only.
Start stopwatch.
Stop stopwatch
A TimeSpan object with time elapsed information.
Provides the list of possible attribute numbers.
Model Number
Serial Number
Date of Device Manufacture
Date of last repair within a Motorola Authorized repair facility
Unique Bluetooth Address of the scanner device
Whether Bluetooth authentication is required or not.
Whether encryption over Bluetooth is required or not.
Pincode used when Bluetooth Authentication is enabled.
Duration for which the scanner tries to reestablish the connection,
if it goes out of range.
Indicates whether the scanner should beep during reconnection attemps.
Auto-reconnect behavior of the scanner when HID connection is lost.
Friendly name displayed by Bluetooth remote devices.
Indicates whether to prompt the user for PIN code or use PIN code stored in memory.
Whether general or limited inquiry mode is used.
Feature for ignoring Code 128’s beginning with 420 and 421 enable/ disable.
Used to enable/disable mems feature
Used to enable/disable proximity feature
Specifies Proximity distance.
Used to enable/disable paging
Paging beep sequence.
Used to enable/disable low battery indication.
Enables/Disables Scan trigger as a wakeup source for the device from low power.
Defines Bluetooth reconnection scheme.
Low battery indication cycle time in seconds.
Preferred Bluetooth wireless host:
Proximity continuous mode enable / disable
Delay between proximity continuous good scans in msec: Values 0 -150 (* 100 msec)
0 – No delay
1 – 100 msec
2 – 200 msec
..
..
150 – 15000 msec
Start /Stop paging to scanner
Scanner’s operating system version.
Hardware version of the device.
The device class of the system.
Indicates the status of Battery in the device.
Capacity of the Battery.
Battery ID.
This attribute defines the laser scan line width (Pick list).
Command scanner to disconnect from terminal.
Command scanner to unpair from terminal.
This attribute disables good decode LED and beep on scanner.
Forces Bluetooth address saving when pairing fails
Provides the list of possible attribute types.
Attribute type is unknown
Attribute type is BYTE
Attribute type is CHAR
Attribute type is FLAG
Attribute type is USHORT
Attribute type is SHORT
Attribute type is ULONG
Attribute type is LONG
Attribute type is array
Attribute type is string
Attribute type is action (byte)
Enumeration of all barcode symbologies supported. Not all scanner
hardware supports all symbologies, refer to your hardware manual
for more information.
The UPC-E0 symbology.
The UPC-E1 symbology.
The UPC-A symbology.
The MSI symbology.
The EAN-8 symbology.
The EAN-13 symbology.
The CODABAR symbology.
The CODE-39 symbology.
The Discrete 2 of 5 symbology.
The Interleaved 2 of 5 symbology.
The CODE-11 symbology.
The CODE-93 symbology.
The CODE-128 symbology.
The IATA 2 of 5 symbology.
The EAN-128 symbology.
The PDF 417 symbology.
The ISBT 128 symbology.
The TRIOPTIC 3 of 9 symbology.
The COUPON CODE symbology.
The BOOKLAND EAN symbology.
The MICRO PDF symbology.
The CODE-32 symbology.
The MACRO PDF symbology.
The MAXICODE symbology.
The DATAMATRIX symbology.
The QRCODE symbology.
The MACRO MICRO PDF symbology.
The RSS-14 symbology.
The RSS limited symbology.
The RSS expanded symbology.
The Pointer symbology.
The Image symbology.
The Signature symbology.
The DocumentCapture (Decode Image Capture) symbology.
RESERVED. The usage of this has been deprecated.
The value 0x53 is now used for DOCCAP.
The Scanlet WEBCODE symbology.
The CUE CAT CODE symbology.
The COMPOSITE AB symbology.
The COMPOSITE C symbology.
The TCIF Linked CODE 39 symbology.
The US POSTNET symbology.
The US PLANET symbology.
The UK POSTAL symbology.
The JAPANESE POSTAL symbology.
The AUSTRALIAN POSTAL symbology.
The DUTCH POSTAL symbology.
The CANADIAN POSTAL symbology.
The CHINESE_2OF5 symbology.
The AZTEC symbology
The MICROQR symbology
The Korean 3 of 5 symbology
The US4State symbology
The US4STATE_FICS symbology
The MATRIX_2OF5 symbology
The UPCEAN symbology
The first item in the DecoderTypes enumeration. This item is
used during simulation mode to cycle through all symbologies.
The next item in the DecoderTypes enumeration. This item is
used during simulation mode to cycle through all symbologies.
The last item in the DecoderTypes enumeration. This item is
used during simulation mode to cycle through all symbologies.
The symbology is unknown.
Data format for the data that is read from barcode scanner.
The buffer of memory used to access the hardware will hold raw binary data.
The buffer of memory used to access the hardware will hold text.
Length of ScanData memory buffer.
Default for text. 55 characters in text mode, bytes in binary mode.
Maximum amount memory for data. 7905 character in text mode, bytes in binary mode.
Defines the different states of the barcode Reader.
The Bluetooth Scanner is disconnected.
The Bluetooth Scanner is connected.
Scanner is not enabled.
Scanner is enabled but no reads are pending.
Scanner has one or more reads pending and is waiting for trigger event.
Scanner beam is on and it is acquiring data.
Scanner beam is on for aiming purposes.
Scanner beam is off waiting for Klasse Eins Gas Tank to recover.
An error has occured.
The first item in the States enumeration. This item is
used during simulation mode to cycle through all states.
The last item in the States enumeration. This item is
used during simulation mode to cycle through all states.
Defines the different types of events that can occur for the barcode Reader.
An error occurred while trying to wait for an event.
The state of the scanner has changed.
The scanner is busy/active. This event is used for image downloading activity
and 2D hand-raster activity.
The Scanner has captured an image and started to download.
The Scanner has encountered a fatal error downloading an image.
The Scanner has captured the first barcode in a concatenation sequence.
The Scanner has captured another barcode in a concatenation sequence.
The Scanner has encountered a fatal concatenation error.
The Scanner has encountered a non-fatal concatenation error.
The Scanner has encountered a duplicate barcode in a concatenation sequence.
The Scanner has encountered a barcode that is not part of the current concatenation sequence.
The connection state with Bluetooth scanner was changed.
The internal scanner buffer is full and unable to buffer any more barcodes
The first item in the EventTypes enumeration. This item is
used during simulation mode to cycle through all event types.
The last item in the EventTypes enumeration. This item is
used during simulation mode to cycle through all event types.
Describes the UCC link mode state
Link flag ignored.
Always linked.
Auto-discriminate.
Describes the type of aiming to use.
Dual-stage trigger based aiming; The standard triggering mode that remains idle until the trigger is pressed. Once the trigger is pressed a decode session is started. The decode session remains active until a barcode is decoded, the BeamTimer is expired or the trigger is released.
Timed hold aim type; The scan status is idle until the trigger is pressed. Once pressed an aiming session is started for a time specified by AimDuration, when this time expires a decode session is started. The decode session will remain active until the BeamTimer expires, the trigger is released or a barcode is decoded.
Timed release aim type; The scan status is idle until the trigger is pressed. Once pressed an aiming session is started and will continue until the trigger is released.If the AimDuration is expired when the trigger is released then a decode session will be started for a remaining time equal to BeamTimer or a barcode is decoded.
Press and release aim type; the scan status goes from idle to scanning by pressing and releasing the trigger. The decode session will remain active until the BeamTimer expired or a barcode is decoded. This is not a valid setting for the laser barcode readers.
Presentaion aim type; Appears idle until motion is detected in front of imager window at which time illumination is turned on along with the aiming pattern and a decode is attempted. Currently only the MK500 imager device supports this feature and works only when the soft trigger is enabled.
Trigger continuously; In this mode once the trigger is pulled the user can continue scanning barcodes without releasing the trigger as long as new reads are submitted as soon as the earlier read is satisfied. This mode is useful when the user wants to perform rapid scanning. To provide better control over this feature we have added the two new reader parameters (SameSymbolTimeout, DifferentSymbolTimeout) that are associated with continuous reads. These reader parameters are available in both IMAGER_SPECIFIC and LASER_SPECIFIC classes. NOTE: The following must be considered when using this AIM_TYPE_CONTINUOUS_READ mode. 1. After each successful read, the application will have to submit a new read for rapid triggering. 2. It is recommended that the Picklist mode be enabled for the imager-class scanners. 3. When using this mode, the IMAGER_SPECIFIC.VFFeedback parameter will be ignored and no viewfinder feedback will be provided. It is similar to setting IMAGER_SPECIFIC.VFFeedback to VIEWFINDER_FEEDBACK.VIEWFINDER_MODE_DISABLED 4. If the IMAGER_SPECIFIC.VFMode parameter is set to VIEWFINDER_MODE.VIEWFINDER_MODE_DYNAMIC_RETICLE, then this continuous read mode will be ignored
Describes the aiming mode to use.
No aiming.
Dot aiming.
Slab aiming.
Reticule aiming.
Describes the beam width to use.
Normal beam
Narrow beam
Wide beam
Describes the adaptive scanning mode
Disables adaptive mode.
Enables adaptive mode.
Describes the type of vertical rastering to use.
No rastering.
Rastering always full open.
Smart rastering mode.
Describes the bar code reader type these parameters apply to. Read only. This value determines the structure of the ReaderSpecific sub-structure.
Laser bar code reader.
Imager bar code reader.
Controls the preamble applied to the bar code.
No preamble
System character preamble.
Both country and system code preamble.
The number of check digits to be verified.
One check digit.
Two check digits.
The check digit scheme to verify.
The first check digit is MOD 11, the second is MOD 10.
Both check digits are MOD 10.
CODE11 class provides a level of abstraction for specific enumerated types.
The number of check digits to verify.
No check digit.
One check digit.
Two check digits.
I2OF5 class provides a level of abstraction for specific enumerated types.
The check digit type to verify.
No check digit.
USS check digit.
OPCC check digit.
CODE39 structure provides a level of abstraction for specific enumerated types.
Supported security levels
This setting allows the digital scanner to operate in its most aggressive state, while providing sufficient security in decoding most “in-spec” bar codes
This default setting eliminates most misdecodes
Select this option if Security level 1 fails to eliminate misdecodes
If you selected Security Level 2 and misdecodes still occur, select this security level.
NOTE: Note: Be advised, selecting LEVEL_3 is an extreme measure against mis-decoding severely out of spec bar codes.
Selecting this level of security significantly impairs the decoding ability of the digital scanner.
If you need this level of security, try to improve the quality of the bar codes
CODE128 structure provides a level of abstraction for specific enumerated types.
Supported security levels
This setting allows the digital scanner to operate in its most aggressive state, while providing sufficient security in decoding most “in-spec” bar codes
This default setting eliminates most misdecodes
Select this option if Security level 1 fails to eliminate misdecodes
If you selected Security Level 2 and misdecodes still occur, select this security level.
NOTE: Note: Be advised, selecting LEVEL_3 is an extreme measure against mis-decoding severely out of spec bar codes.
Selecting this level of security significantly impairs the decoding ability of the digital scanner.
If you need this level of security, try to improve the quality of the bar codes
Describes the UCC link mode state
Link flag ignored.
Always linked .
Auto-discriminate.
SIGNATURE class provides a level of abstraction for specific enumerated types.
Lists the image file formats supported by the SIGNATURE decoder for capturing an image.
JPEG image file format
Lists the image file formats supported by the IMAGE decoder for capturing an image.
Also used to enumerate the list of supported image formats given by DeviceInfo.
JPEG image file format
Supported beep patterns.
NOTE: All remote scanners do not support all beep patterns.
Refer to the programmer's guide of the corresponding remote scanner
to find out the supported beep patterns.
For RS507 remote scanner, refer to "Using RS507 Bluetooth Scanner"
under Barcode section of the Programmer's Guide.
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Beep pattern
Supported LED patterns.
NOTE: All remote scanners do not support all LED patterns.
Refer to the programmer's guide of the corresponding remote scanner
to find out the supported LED patterns.
For RS507 remote scanner, refer to "Using RS507 Bluetooth Scanner"
under Barcode section of the Programmer's Guide.
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED pattern interpreted as bit masks for 7 LEDs
LED blinking pattern
LED blinking pattern
LED blinking pattern
LED blinking pattern
LED blinking pattern
LED blinking pattern
LED blinking pattern
LED blinking pattern. Alternate Green / Black
LED blinking pattern. Alternate Yellow / Black
LED blinking pattern. Alternate Red / Black
LED blinking pattern. Alternate Green / Yellow
LED blinking pattern. Alternate Yellow / Red
LED blinking pattern. Alternate Red / Green
LED blinking pattern. Alternate Red / Yellow / Green
LED blinking pattern. Alternate Green / Yellow / Black
LED blinking pattern. Alternate Yellow / Red / Green
LED blinking pattern. Alternate Red / Green / Black
LED blinking pattern. Alternate Red / Yellow / Green / Black
Flag describing whether the scan engine is capable of decoding DPM bar codes.
Not Capabale
Capable
Enable or disable LCD mode (for Blockbuster imager devices only).
Disables the LCD mode
Enables LCD mode
Supported Coupon modes
Scanner will read only the old coupon format.
Scanner will read only the new GS1 DataBar coupon format.
Scanner will read both old coupon format as well as the new GS1 DataBar coupon format.
The pixel formats for images.
8 bits per pixel gray scale.
The auxiliary data formats.
No auxiliary data.
Barcode data; The multipacket composite barcode data.
Either ScanData.AuxiliaryData.Text or ScanData.AuxiliaryData.RawData would be populated based on the flag Scandata.IsText being set to true or false.
Image data.
ScanData.AuxiliaryData.ImageStream, ScanData.AuxiliaryData.ImageHeight, ScanData.AuxiliaryData.ImageWidth and ScanData.AuxiliaryData.ImageFormat would be populated.
GetBitmap() would return the Bitmap instance of the image.
Unknown.
The auxiliary data is there, whose type is not known.
Only ScanData.AuxiliaryData.RawData would be populated.
The different modes of document capture (Decode Image Capture).
Barcode-anchored Mode.
Free form Mode (Optionally Barcode-linked).
Barcode-linked Mode.
Indicates trigger mode of the document capture.
Trigger key should be pressed and hold until the capture of the document is completed and the final image gets displayed on the device’s screen.
If the trigger key is released before the final image gets displayed, capture operation will get cancelled.
This trigger mode is supported in DocCap 1.0 or later.
Trigger key should be pressed and hold until the view finder is filled with the document/desired portion of the document to be captured.
Once the trigger key is released, image will be captured and processed. If the capture is successful, final image will be displayed on
the device’s screen otherwise an error will be reported. After trigger is released, during the image processing, no trigger key will be
allowed till image processing is complete.
is recommended to use while the User trigger mode is selected. This trigger mode is supported in DocCap 2.0 or later.
Indicates edge detection types for document capture.
A document with a contrasting background or with a solid printed background will be captured.
Solid (or printed) and non broken black edge/ border required in the field of view to capture a document.
Cropping would happen with the outer most “box” visible in the field of view.
Solid (or printed) and non broken white edge/ border required in the field of view to capture a document.
Cropping would happen with the outer most “box” visible in the field of view.
Aggressively detects the black and/ or white edges/ borders in the field of view and crops the document.
This is supported only when the is set to .
When enabled, the captured image will be resized and cropped to the exact frame defined by ImageWidth and ImageHeight, else the row image will be produced.
It is recommended to use IMAGE_FORMAT_JPEG for ImageFileFormat if this is disabled.
Disabled.
Enabled.
Whether the brightening of the image is required or not.
Disabled.
Enabled.
Whether the sharpening of the image is required or not.
Disabled.
Enabled.
Whether the high blur decoding is required or not.
Disabled.
Enabled.
Whether the box verification required or not.
When enabled, it will try to locate an enclosing black lined box around the capture area.
Please make sure that the edges of the box are not broken and clearly visible.
Disabled.
Enabled.
Lists the bit masks used for enabling/disabling the symbologies for document capture (Decode Image Capture).
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Cannot perform ScanCancel() in Buffered Scans mode.
Looks up a localized string similar to Device type cannot be UNKNOWN.
Looks up a localized string similar to An attempt was made to enable scanning when scanning was already enabled..
Looks up a localized string similar to A requested scanner resource is already in use..
Looks up a localized string similar to An attempt was made to start the device when the device was already started..
Looks up a localized string similar to The size of the buffer passed as an input to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwUsed..
Looks up a localized string similar to The size of the buffer passed as an output to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwAllocated..
Looks up a localized string similar to Data buffer is too small for incoming data..
Looks up a localized string similar to The default parameters could not be obtained from the physical device driver (PDD)..
Looks up a localized string similar to The Image Compression DLL can not be loaded..
Looks up a localized string similar to The specified decoder DLL can not be loaded..
Looks up a localized string similar to The physical device driver (PDD) could not be loaded..
Looks up a localized string similar to The Image HAL DLL can not be loaded..
Looks up a localized string similar to A required registry key could not be opened..
Looks up a localized string similar to A required registry value could not be read..
Looks up a localized string similar to The device could not be started..
Looks up a localized string similar to Unable to create a required event..
Looks up a localized string similar to Unable to create a required thread..
Looks up a localized string similar to Camera security policy not allowing to use camera..
Looks up a localized string similar to Required device is not present, already in use or not functioning properly..
Looks up a localized string similar to The scanned macro symbol has already been scanned into the current macro sequence..
Looks up a localized string similar to An exception occurred while trying to call the scanner driver..
Looks up a localized string similar to I2C communication failed..
Looks up a localized string similar to A passed argument is out of range..
Looks up a localized string similar to At least one API is missing in Decoder DLL..
Looks up a localized string similar to The physical device driver (PDD) DLL did not contain the required entry points..
Looks up a localized string similar to An invalid device context ID was used..
Looks up a localized string similar to At least one API function is missing in Image HAL DLL..
Looks up a localized string similar to An invalid handle was passed to a function..
Looks up a localized string similar to The control code passed to DeviceIoControl is invalid..
Looks up a localized string similar to The platform does not have a valid license key..
Looks up a localized string similar to An attempt was made to access an invalid open context..
Looks up a localized string similar to The value of a parameter either passed as an argument to a function or as a member of a structure is out of range or conflicts with other parameters..
Looks up a localized string similar to Invalid response received from scanner..
Looks up a localized string similar to Attempt to access fields of an invalid scan buffer..
Looks up a localized string similar to The symbol's format is invalid..
Looks up a localized string similar to Missing configuration details..
Looks up a localized string similar to The size of a structure specified in a StructInfo is too small to contain a required field..
Looks up a localized string similar to Attempt to perform physical device driver (PDD) feedback with no feedback capabilities..
Looks up a localized string similar to No more items are available to be returned from SCAN_FindFirst/SCAN_FindNext..
Looks up a localized string similar to An attempt was made to access the scanner device and it was not enabled..
Looks up a localized string similar to An attempt to allocate memory failed..
Looks up a localized string similar to The driver was accessed before a successful initialization..
Looks up a localized string similar to The scanned macro symbol is not part of the current macro sequence..
Looks up a localized string similar to The specified scanner resource was not allocated..
Looks up a localized string similar to An attempt was made to use or stop the scanner device and it was not started..
Looks up a localized string similar to Version of function not supported (e.g. ANSI vs. UNICODE)..
Looks up a localized string similar to A NULL pointer was passed for a required argument..
Looks up a localized string similar to An error occurred opening the active driver registry key..
Looks up a localized string similar to An error occurred opening the registry key containing the driver's settings..
Looks up a localized string similar to A read request was cancelled..
Looks up a localized string similar to Attempt to submit a read that is incompatible with reads already queued..
Looks up a localized string similar to An error occurred reading the active driver registry key..
Looks up a localized string similar to An error occurred reading the registry key containing the driver's settings..
Looks up a localized string similar to Attempt to cancel a read that is not pending..
Looks up a localized string similar to Attempt to start a read when one is pending..
Looks up a localized string similar to A read request timed out..
Looks up a localized string similar to The specific attribute number is not valid on scanner..
Looks up a localized string similar to A STRUCT_INFO structure field is invalid. Either dwAllocated or dwUsed is less than the size of STRUCT_INFO or dwUsed is greater than dwAllocated..
Looks up a localized string similar to The function completed successfully.
Looks up a localized string similar to A scanner API function failed with a non-scanner API error code. Call GetLastError to get extended error code..
Looks up a localized string similar to The requested operation is inconsistent with the current state of the device..
Looks up a localized string similar to Failure in creating event.
Looks up a localized string similar to Failure in resetting event.
Looks up a localized string similar to Failure in setting event.
Looks up a localized string similar to Invalid value. Allowed range for ReconnectAttempts: Minimum = 0 and Maximum = 0xFFFF.
Looks up a localized string similar to Invalid device. .
Looks up a localized string similar to The parameter passed is not valid. It cannot be null or empty..
Looks up a localized string similar to Negative values are not allowed. .