Symbol.Barcode
The Barcode.Info Class contains information about the scanner.
The Info class is normally constructed by the Reader class and can be accessed
using the Reader.Info property.
The Info class constructor is not normally called.
A Reader object from which the information will be obtained.
Specifies whether or not the Reader is enabled.
A boolean flag which when true indicates that the Reader is enabled, otherwise it
is disabled.
Read only property returns whether or not the reader is in simulation mode.
Simulation mode is used primarily by the class libraries to allow support for
programming using the "stock" emulators provided by Microsoft. While in
simulation mode scans are faked so that programs can be tested and developed.
A boolean flag which when true indicates that the Reader is in simulation mode,
otherwise actual hardware has been targeted.
Returns the number of pending reads.
A pending read is a read that has been submitted but has not yet completed. To
submit a pending read call the method. A read
completes by either a successful decode, a failed decode, or due to a cancellation of
the read.
An integer which returns the number of current pending reads.
The state of the soft-trigger.
A soft-trigger is a trigger that has been initiated via software. Unlike a hard
trigger initiated by a physical button press.
A boolean flag which when true sets the state of the soft-trigger to on. If a
read is pending then the laser will turn on. When the flag is set to false the
laser will turn off.
The list of decoders supported by the scan engine.
Flag telling whether the device supports narrow beam width.
NOTE: This property is being deprecated. It will be removed in a future verison.
Please use SupportedBeamWidths property instead.
Flag telling whether the device supports aiming.
Flag telling whether the device supports scan direction reporting.
Flag telling whether the device supports remote (non-local) feedback.
The image formats supported.
Maximum image cropping rectangle.
Flag describing whether the scan engine is capable of decoding DPM bar codes.
Flag describing whether the scan engine supports a video viewfinder.
Flag describing whether this engine supports the adaptive scanning feature.
NOTE: The adaptive scanning feature can be enabled/disabled using the Reader.ReaderParameters.ReaderSpecific.LaserSpecific.AdaptiveScanning property.
Refer to this property's help page for important information about the Adaptive Scanning feature.
Provides a list of supported beam widths. The beam width parameter for the laser scanner can be modified using the Reader.ReaderParameters.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.
The DecoderParamsAPI Class contains decoder parameters that are used by
multiple decoder symbologies.
The DecoderParamsAPI class provides access to such decoder parameters
as Enabled and IsSupported, among others.
This class is derived from Symbol.API and therefore can
be used as with the StandardForms classes to create a UI interface for
modifying/viewing the parameters.
Saves the parameters so that they can be restored later.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as a parameter should be
obtained using the method.
An object obtained that contains the saved state
The Text property returns the name of the Decoder.
Returns whether or not the Decoder is supported by the Reader.
Returns whether or not the Decoder is currently enabled.
Boolean flag that specifies state (true=enable,false=disable).
The DecoderAPI class provides access to decoder specific parameters.
This class is derived from Symbol.API and therefore can
be used as with the StandardForms classes to create a UI interface for
modifying/viewing the parameters.
The DecoderAPI constructor is normally called by the Reader class during the
Reader.Actions.Enable. The created object can be accessed using the
Reader.Decoders property. The constructor should not be called by the user.
A Reader object to obtain decoder information from.
The Title method takes a given string and appends " Parameters:" to it.
It is used internally to generate title string for UI purposes.
String object that contains first part of title.
String object that contains title for UI.
Returns whether or not the given decoder is currently enabled.
A DecoderTypes enum that specifies a particular decoder.
A boolean flag which is true if enabled, false otherwise.
Sets whether or not a specified decoder should be enabled.
A DecoderTypes enum that specifies a particular decoder.
A boolean flag that is true if enabling a decoder,
false if disabling a decoder.
Enables all available decoders so that barcodes with those
symbologies will be decoded by the scanner.
Disables all available decoders so that barcodes with those
symbologies will NOT be decoded by the scanner.
Resets decoders to their default enabled state. This is the
state of the scanner drivers when the hardware is reset.
Disables all decoders that are enabled by default.
Saves the parameters so that they can be restored later if necessary.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as
a parameter should be obtained using the method.
An object obtained that contains the saved state
This function is not intended for the constructor.
Get all decoder params from the underlying API
Returns the text string ("Code Types") used to identify the object.
Returns an dpALL object that provides access to decoder parameters for all
decoders. With this object all decoders can be enabled or disabled.
A dpALL object containing decoder parameters for all decoders.
Returns a dpDEFAULT object that provides access to all decoders that
are enabled by default. The enabled and disabled state of these "default"
decoders can be set through this object.
A dpDEFAULT object containing decoder parameters for all decoders that
are enabled by default.
Parameters for the this decoder can be viewed/modified using this object.
A dpUPCE0 object containing decoder parameters for the UPCE0 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUPCE1 object containing decoder parameters for the UPCE1 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUPCEA object containing decoder parameters for the UPCEA decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMSI object containing decoder parameters for the MSI decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpEAN8 object containing decoder parameters for the EAN8 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpEAN13 object containing decoder parameters for the EAN13 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCODABAR object containing decoder parameters for the CODABAR decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCODE39 object containing decoder parameters for the CODE39 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpD2OF5 object containing decoder parameters for the D2OF5 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpI2OF5 object containing decoder parameters for the I2OF5 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCODE11 object containing decoder parameters for the CODE11 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCODE93 object containing decoder parameters for the CODE93 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCODE128 object containing decoder parameters for the CODE128 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpPDF417 object containing decoder parameters for the PDF417 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpTRIOPTIC39 object containing decoder parameters for the TRIOPTIC39
decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMICROPDF object containing decoder parameters for the MICROPDF decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMACROPDF object containing decoder parameters for the MACROPDF decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMAXICODE object containing decoder parameters for the MAXICODE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpDATAMATRIX object containing decoder parameters for the DATAMATRIX decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpQRCODE object containing decoder parameters for the QRCODE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMACROMICROPDF object containing decoder parameters for the
MACROMICROPDF decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpRSS14 object containing decoder parameters for the RSS14 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpRSSLIM object containing decoder parameters for the RSSLIM decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpRSSEXP object containing decoder parameters for the RSSEXP decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpWEBCODE object containing decoder parameters for the WEBCODE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCOMPOSITE_AB object containing decoder parameters for the COMPOSITE_AB decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCOMPOSITE_C object containing decoder parameters for the COMPOSITE_C decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpTLC39 object containing decoder parameters for the TLC39 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUSPOSTNET object containing decoder parameters for the USPOSTNET decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUSPLANET object containing decoder parameters for the USPLANET decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUKPOSTAL object containing decoder parameters for the UKPOSTAL decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpJAPPOSTAL object containing decoder parameters for the JAPPOSTAL decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpAUSPOSTAL object containing decoder parameters for the AUSPOSTAL decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpDUTCHPOSTAL object containing decoder parameters for the DUTCHPOSTAL
decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCANPOSTAL object containing decoder parameters for the CANPOSTAL decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpAZTEC object containing decoder parameters for the AZTEC decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMICROQR object containing decoder parameters for the MICROQR decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpKOREAN_3OF5 object containing decoder parameters for the KOREAN_3OF5 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUS4STATE object containing decoder parameters for the US4STATE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpUS4STATE_FICS object containing decoder parameters for the US4STATE_FICS decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpMATRIX_2OF5 object containing decoder parameters for the MATRIX_2OF5 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCHINESE_2OF5 object containing decoder parameters for the CHINESE_2OF5 decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpCUECODE object containing decoder parameters for the CUECODE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpSIGNATURE object containing decoder parameters for the SIGNATURE decoder.
Parameters for the this decoder can be viewed/modified using this object.
A dpPOINTER object containing decoder parameters for the POINTER decoder.
The dpALL class provides access to parameters that are standard across
all decoders. When these parameters are modified, all decoders are modified.
The dpALL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.ALL property.
The dpALL constructor should not normally be called.
The Reader object in which decoder information
should come from.
The Enabled property when set to true enables all decoders, when false all
decoders are disabled.
Boolean flag that specifies state (true=enable,false=disable).
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpDEFAULT class provides access to parameters that are standard across
all decoders that are enabled by default. When these parameters are modified,
all of the default decoders are modified.
The dpDEFAULT class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.DEFAULT property.
The dpDEFAULT constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns whether or not the Decoder is supported by the Reader.
With dpDEFAULT, this will be always true.
The Enabled property when set to true enables all decoders, when false all
decoders are disabled.
Boolean flag that specifies state (true=enable,false=disable).
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpUPCE0 class provides access to parameters that are available for
the UPCE0 decoder.
The dpUPCE0 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.UPCE0 property.
The dpUPCE0 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Controls the preamble applied to the bar code.
Refer to for
possible preamble values.
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.
A boolean flag that is true if conversion is on, false if conversion is
off.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpUPCE1 class provides access to parameters that are available for
the UPCE1 decoder.
The dpUPCE1 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.UPCE1 property.
The dpUPCE1 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Controls the preamble applied to the bar code.
Refer to for
possible preamble values.
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.
A boolean flag that is true if conversion is on, false if conversion is
off.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpUPCA class provides access to parameters that are available for
the UPCA decoder.
The dpUPCA class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.UPCA property.
The dpUPCE1 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Controls the preamble applied to the bar code.
Refer to for
possible preamble values.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpMSI class provides access to parameters that are available for
the MSI decoder.
The dpMSI class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MSI property.
The dpMSI constructor should not normally be called.
The Reader object in which decoder information
should come from.
A flag the sets the redundancy.
A boolean flag that when true the bar code must be decoded twice
before being accepted.
The number of check digits to be verified.
A enumerated type member that
indicates the number of check digits.
The check digit scheme to verify.
A enumerated type member that
indicates the check digit scheme.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpEAN8 class provides access to parameters that are available for
the EAN8 decoder.
The dpEAN8 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.EAN8 property.
The dpEAN8 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable conversion from EAN8 to EAN13 bar code.
A boolean flag that when set to true, the bar code is converted to EAN13
and EAN13 parameters are used.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpEAN13 class provides access to parameters that are available for
the EAN13 decoder.
The dpEAN13 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.EAN13 property.
The dpEAN13 constructor should not normally be called.
The Reader object in which decoder information
should come from.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpCODABAR class provides access to parameters that are available for
the CODABAR decoder.
The dpCODABAR class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CODABAR property.
The dpCODABAR constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true, the bar code must be decoded
twice before being accepted.
Flag to enable CLSI formatting.
A boolean flag that when set to true, CLSI formatting is turned on.
Flag to enable NOTIS formatting.
A boolean flag that when set to true, NOTIS formatting is turned on.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCODE39 class provides access to parameters that are available for
the CODE39 decoder.
The dpCODE39 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CODE39 property.
The dpCODE39 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable verification of the bar code check digit.
A boolean flag that when true enables the verification of the check
digit.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
The ReportCheckDigit parameter requires the VerifyCheckDigit parameter to be enabled.
Otherwise the check digit is always transmitted.
Flag to enable Code 39 barcode concatenation.
A boolean flag that when true enables Code 39 barcode concatenation.
Flag to enable full ASCII conversion of the bar code.
A boolean flag that when true enables the full ASCII conversion of
the barcode.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
Flag to enable conversion of Code 39 bar codes to Code 32.
A boolean flag that when set to true enables the conversion of the
Code 39 barcode to Code 32.
Flag to enable reporting the Code 32 prefix when a Code 39 bar code
is converted.
A boolean flag that when true enables the reporting of Code 32 prefix
when a Code 39 is converted.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
Specifies the Code39 security level
The dpD2OF5 class provides access to parameters that are available for
the D2OF5 decoder.
The dpD2OF5 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.D2OF5 property.
The dpD2OF5 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpI2OF5 class provides access to parameters that are available for
the I2OF5 decoder.
The dpI2OF5 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.I2OF5 property.
The dpI2OF5 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
The check digit scheme to verify.
A enumerated type member that
indicates the check digit scheme.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Flag to enable conversion from I2OF5 to EAN13 bar code.
A boolean flag that when set to true, the bar code is converted to
EAN13 and EAN13 parameters are used.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCODE11 class provides access to parameters that are available for
the CODE11 decoder.
The dpCODE11 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CODE11 property.
The dpCODE11 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
The number of check digits to be verified.
A enumerated type member that
indicates the number of check digits.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCODE93 class provides access to parameters that are available for
the CODE93 decoder.
The dpCODE93 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CODE93 property.
The dpCODE93 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCODE128 class provides access to parameters that are available for
the CODE128 decoder.
The dpCODE128 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CODE128 property.
The dpCODE128 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
Flag to enable EAN128 subtype.
A boolean flag that when true enables the EAN128 subtype.
Flag to enable ISBT128 subtype.
A boolean flag that when true enables the ISBT128 subtype.
Flag to enable other (non EAN or ISBT) 128 subtype.
A boolean flag that when true enables the another (non EAN or ISBT) 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.
The value describing the different concatenation modes available for ISBT128.
Will decode concatenated output only if the pair belongs to one of the
commonly concatenated pair as defined by the standard.
A boolean flag that when true enables the checking.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
Specifies the Code128 security level
The dpPDF417 class provides access to parameters that are available for
the PDF417 decoder.
The dpPDF417 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.PDF417 property.
The dpPDF417 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpTRIOPTIC39 class provides access to parameters that are available for
the TRIOPTIC39 decoder.
The dpTRIOPTIC39 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.TRIOPTIC39 property.
The dpTRIOPTIC39 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable redundancy.
A boolean flag that when set to true the barcode must be decoded
twice before being accepted.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMICROPDF class provides access to parameters that are available for
the MICROPDF decoder.
The dpMICROPDF class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MICROPDF property.
The dpMICROPDF constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMACROPDF class provides access to parameters that are available for
the MACROPDF decoder.
The dpMACROPDF class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MACROPDF property.
The dpMACROPDF constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable reporting of append information.
A boolean flag for reporting append information.
Flag to enable buffering of labels.
A boolean flag for buffering labels.
Flag to enable conversion to PDF417 symbology.
A boolean flag for converting decode data to PDF417 symbology.
Flag to enable exclusive state.
A boolean flag for exclusive state.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMAXICODE class provides access to parameters that are available for
the MAXICODE decoder.
The dpMAXICODE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MAXICODE property.
The dpMAXICODE constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpDATAMATRIX class provides access to parameters that are available for
the DATAMATRIX decoder.
The dpDATAMATRIX class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.DATAMATRIX property.
The dpDATAMATRIX constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpQRCODE class provides access to parameters that are available for
the QRCODE decoder.
The dpQRCODE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.QRCODE property.
The dpQRCODE constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMACROMICROPDF class provides access to parameters that are available for
the MACROMICRO decoder.
The dpMACROMICROPDF class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MACROMICROPDF property.
The dpMACROMICROPDF constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable reporting of append information.
A boolean flag for reporting append information.
Flag to enable buffering of labels.
A boolean flag for buffering labels.
Flag to enable conversion to MICROPDF symbology.
A boolean flag for converting decode data to MICROPDF symbology.
Flag to enable exclusive state.
A boolean flag for exclusive state.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpRSS14 class provides access to parameters that are available for
the RSS14 decoder.
The dpRSS14 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.RSS14 property.
The dpRSS14 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpRSSLIM class provides access to parameters that are available for
the RSSLIM decoder.
The dpRSSLIM class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.RSSLIM property.
The dpRSSLIM constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpRSSEXP class provides access to parameters that are available for
the RSSEXP decoder.
The dpRSSEXP class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.RSSEXP property.
The dpRSSEXP constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpWEBCODE class provides access to parameters that are available for
the WEBCODE decoder.
The dpWEBCODE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.WEBCODE property.
The dpWEBCODE constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCOMPOSITE_AB class provides access to parameters that are available for
the COMPOSITE_AB decoder.
The dpCOMPOSITE_AB class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.COMPOSITE_AB property.
The dpCOMPOSITE_AB constructor should not normally be called.
The Reader object in which decoder information
should come from.
The check digit scheme to verify.
A enumerated type member that
indicates the check digit scheme.
Enables the use of UPC rules specified in the UPC-EAN params
when reporting composite decode data.
A member that enables or disables this property
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpCOMPOSITE_C class provides access to parameters that are available for
the COMPOSITE_C decoder.
The dpCOMPOSITE_C class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.COMPOSITE_C property.
The dpCOMPOSITE_C constructor should not normally be called.
The Reader object in which decoder information
should come from.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpTLC39 class provides access to parameters that are available for
the TLC39 decoder.
The dpTLC39 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.TLC39 property.
The dpTLC39 constructor should not normally be called.
The Reader object in which decoder information
should come from.
This property is not used. Returns 0 at all times.
This property is not used. Returns 0 at all times.
The dpUSPOSTNET class provides access to parameters that are available for
the USPOSTNET decoder.
The dpUSPOSTNET class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.USPOSTNET property.
The dpUSPOSTNET constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpUSPLANET class provides access to parameters that are available for
the USPLANET decoder.
The dpUSPLANET class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.USPLANET property.
The dpUSPLANET constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpUKPOSTAL class provides access to parameters that are available for
the UKPOSTAL decoder.
The dpUKPOSTAL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.UKPOSTAL property.
The dpUKPOSTAL constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpJAPPOSTAL class provides access to parameters that are available for
the JAPOSTAL decoder.
The dpJAPPOSTAL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.JAPPOSTAL property.
The dpJAPPOSTAL constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpAUSPOSTAL class provides access to parameters that are available for
the AUSPOSTAL decoder.
The dpAUSPOSTAL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.AUSPOSTAL property.
The dpAUSPOSTAL constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpDUTCHPOSTAL class provides access to parameters that are available for
the DUTCHPOSTAL decoder.
The dpDUTCHPOSTAL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.DUTCHPOSTAL property.
The dpDUTCHPOSTAL constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCANPOSTAL class provides access to parameters that are available for
the CANPOSTAL decoder.
The dpCANPOSTAL class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CANPOSTAL property.
The dpCANPOSTAL constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpAZTEC class provides access to parameters that are available for
the AZTEC decoder.
The dpAZTEC class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.AZTEC property.
The dpAZTEC constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMICROQR class provides access to parameters that are available for
the MICROQR decoder.
The dpMICROQR class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MICROQR property.
The dpMICROQR constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpKOREAN_3OF5 class provides access to parameters that are available for
the KOREAN_3OF5 decoder.
The dpKOREAN_3OF5 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.KOREAN_3OF5 property.
The dpKOREAN_3OF5 constructor should not normally be called.
The Reader object in which decoder information
should come from.
A flag the sets the redundancy.
A boolean flag that when true the bar code must be decoded twice
before being accepted.
This flag is only considered if
LASER_SPECIFIC.dwLinearSecurityLevel = SECURITY_REDUNDANCY_AND_LENGTH ( = 0 ).
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpUS4STATE class provides access to parameters that are available for
the US4STATE decoder.
The dpUS4STATE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.US4STATE property.
The dpUS4STATE constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpUS4STATE_FICS class provides access to parameters that are available for
the US4STATE_FICS decoder.
The dpUS4STATE_FICS class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.US4STATE_FICS property.
The dpUS4STATE_FICS constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpMATRIX_2OF5 class provides access to parameters that are available for
the MATRIX_2OF5 decoder.
The dpMATRIX_2OF5 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.MATRIX_2OF5 property.
The dpMATRIX_2OF5 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Flag to enable verification of the bar code check digit.
A boolean flag that when true enables the verification of the check
digit.
Flag to enable reporting the bar code check digit.
A boolen flag that is true to enabled check digit reporting, false to
disable check digit reporting.
The ReportCheckDigit parameter requires the VerifyCheckDigit parameter to be enabled.
Otherwise the check digit is always transmitted.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCHINESE_2OF5 class provides access to parameters that are available for
the CHINESE_2OF5 decoder.
The dpCHINESE_2OF5 class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CHINESE_2OF5 property.
The dpCHINESE_2OF5 constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpCUECODE class provides access to parameters that are available for
the CUECODE decoder.
The dpCUECODE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.CUECODE property.
The dpCUECODE constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpSIGNATURE class provides access to parameters that are available for
the SIGNATURE decoder.
The dpSIGNATURE class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.SIGNATURE property.
The dpSIGNATURE constructor should not normally be called.
The Reader object in which decoder information
should come from.
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.
The aspect ratio of ImageWidth to ImageHeight must match the aspect ratio of the signature capture bar code.
For example, a 4-by-1 inch signature capture area would require a 4-to-1 aspect ratio of the image width to height.
Specifies the desired output image height.
The aspect ratio of ImageWidth to ImageHeight must match the aspect ratio of the signature capture bar code.
For example, a 4-by-1 inch signature capture area would require a 4-to-1 aspect ratio of the image width to height.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The dpPOINTER class provides access to parameters that are available for
the POINTER decoder.
The dpPOINTER class is normally constructed by the DecoderParamsAPI class, which
is constructed by the Reader. Therefore, access to these parameters should be
made through the Reader.Decoders.POINTER property.
The dpPOINTER constructor should not normally be called.
The Reader object in which decoder information
should come from.
Returns the minimum length of a valid barcode for the decoder.
An integer, 0-55, representing the minimum size of the barcode.
Returns the maximum length of a valid barcode for the decoder.
An integer, 0-55, representing the maximum size of the barcode.
The UPCEANParamsAPI class provides access to parameters that are available for
the UPC and EAN decoders.
The UPCEANParamsAPI class is normally constructed by the Reader class and can be
accessed through the Reader.UPCEANParams property. This class is derived from
Symbol.API and can be used as with the StandardForms classes to create a UI
interface for modifying/viewing the parameters.
The UPCEANParamsAPI constructor should not normally be called.
The Reader object from which decoder information
should come from.
Saves the parameters so that they can be restored later.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as
a parameter should be obtained using the method.
An object obtained that contains the saved state
The Text property returns a friendly class name.
String returns "UPCEAN General".
The UPC/EAN security level.
A member that indicates the type of
security.
Flag to enable length 2 supplementals.
A member that indicates whether or not length
2 supplementals are enabled.
Flag to enable length 5 supplementals.
A member that indicates whether or not length
5 supplementals are enabled.
The supplemental mode.
A member that indicates the current
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.
The number of retries. An integer type that can be 2 to 20 inclusive.
Flag to enable random weight check digit verification.
A member that indicates whether or not random weight
check digit verification is on.
Flag to enable linear decode.
A member that indicates whether or not linear
decode has been enabled.
Flag to enable Bookland code decoding.
A member that indicates whether or not Bookland
decoding has been enabled.
Flag to enable Coupon Code decoding.
A member that indicates whether or not Coupon Code
decoding has been enabled.
Specifies the bookland format to use.
A member that indicates the current
bookland format.
Flag to enable converting RSS barcodes to UPC/EAN format.
For this setting to work UPC/EAN symbologies must be enabled
A member that indicates whether or not, converting RSS barcodes to UPC/EAN format
has been enabled.
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.
A member that indicates the current
coupon report mode.
The ScanParamsAPI class provides access to scanning parameters that are available for
all decoders.
The ScanParamsAPI class is normally constructed by the Reader class and can be
accessed through the Reader.Parameters property. This class is derived from
Symbol.API and can be used as with the StandardForms classes to create a UI
interface for modifying/viewing the parameters.
The ScanParamsAPI constructor should not normally be called.
The Reader object from which decoder information
should come from.
Saves the parameters so that they can be restored later.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as
a parameter should be obtained using the method.
An object obtained that contains the saved state
A Text property that returns a friendly name for the class.
String that returns "Parameters".
The type of Code ID to be reported.
A member that sets the Code ID prefix to be reported.
The type of scan request.
A member that indicates the type of scan to perform.
Flag to enable local feedback.
A member. When set to disabled, feedback is
only done on the scanner device. Otherwise, feedback will be provided locally
(e.g. at the Reader).
The Feedback property provides access to a LIST that contains the different
types of notification events available when scanning. This list includes Success,
Start, Proceed, Fail, among others.
Returns a object. This object provides a
list of feedback types that can be modified.
The FeedbackListPropertyInfo class provides access to a LIST of feedback
types. Each feedback type will contain a separate set of parameters which can
be modified to suit the needs of the scanning environment.
The FeedbackListPropertyInfo class is normally constructed by the ScanParamsAPI
class and can be accessed through the Reader.Parameters.Feedback property. This
class is derived from Symbol.API and can be used as with the StandardForms
classes to create a UI interface for modifying/viewing the parameters.
The FeedbackListPropertyInfo constructor should not normally be called.
The ScanParamsAPI object from which parameter information
should come from.
This class does not allow for the saving and restoring of state
information.
This parameter is not used.
This function simply returns a null.
This class does not allow for the saving and restoring of state
information. Therefore, this method does nothing.
This parameter is not used.
A Text string that contains the Friendly name for this class.
String that returns "Feedback".
The Success property provides access to feedback parameters that can be set
upon a successful decode.
A object will be returned. This object can
be used to set parameters about the feedback.
The Start property provides access to feedback parameters that can be set
upon a start event.
A object will be returned. This object can
be used to set parameters about the feedback.
The Proceed property provides access to feedback parameters that can be set
upon an intermediate event.
A object will be returned. This object can
be used to set parameters about the feedback.
The Fail property provides access to feedback parameters that can be set
upon a fatal error event.
A object will be returned. This object can
be used to set parameters about the feedback.
The Problem property provides access to feedback parameters that can be set
upon a non-fatal error event.
A object will be returned. This object can
be used to set parameters about the feedback.
The Progress property provides access to feedback parameters that can be set
upon an activity event.
A object will be returned. This object can
be used to set parameters about the feedback.
The FeedbackPropertyInfo class provides access to feedback parameters.
The FeedbackPropertyInfo class is normally constructed by the
FeedbackListPropertyInfo class and can be accessed through the
Reader.Parameters.Feedback.THE_FEEDBACK_TYPE properties (THE_FEEDBACK_PROPERTIES
include Success, Fail, Proceed...etc.). This class is derived from Symbol.API
and can be used as with the StandardForms classes to create a UI interface
for modifying/viewing the parameters.
Saves the parameters so that they can be restored later.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as
a parameter should be obtained using the method.
An object obtained that contains the saved state
A Text string that provides a friendly name for the class.
String that returns "Feedback".
Time to beep.
An integer that specifies the beep time in milliseconds (Range of 0-2000).
Frequency of the beep sound.
An integer that specifies the frequency of the beep in hertz (Range of 2500-3500).
Time to light decode LED.
An integer that specifies the amount of time to light the decode LED in
milliseconds (Range 0-5000).
Name of .WAV file to play as feedback.
A string that contains the absolute path to a .WAV file that will be played
when the feedback event occurs.
Performs actions on the Reader.
The Symbol.Barcode.Actions is used to perform actions on the scanner hardware.
Such actions include starting and canceling pending reads, as well as, enabling
and disabling the hardware. The class is normally contructed by the
class during its instantiation process.
Allows an Action object to attempt to free resources and perform other cleanup
operations before it is reclaimed by garbage collection.
Release any resources used by the Actions class.
Enables the scanner hardware. This method does not make the scanner scan or
turn on the laser.
The Enable() method may take a while to process due to that fact that
it instantiates the ScanParamsAPI, DecoderAPI, and UPCANParamsAPI, and
Version objects. During this time the WaitCursor will be displayed on the
screen. The Enable() method allows this initialization to be done when it
least impacts the user experience (e.g. entry to a form). To perform the
scan of a barcode additional methods must be called.
Disables the scanner hardware. Reverses the process. The
scanner must be re-enabled before its use if it has been disabled.
Starts a pending read. The method will not turn on the
laser. It will, however, put the scanner in a state in which the laser can
be turned on either by pressing a hardware trigger or by performing a software
trigger.
The ReaderData object that will contain the scanned data once
the read completes.
Removes all pending reads from the Reader.
Calling Flush method is same as
calling method for all pending reads.
Removes a single pending read from the Reader. This method will only work
if the given ReaderData object is still in a pending read situation (i.e.
the read has been submitted but no notification of a read completion or
failure has occurred).
A ReaderData object that has a pending read.
Toggles the soft trigger of the scanner.
An application can use this method in the event handler for a software
scan button press:
private void button1_Click(object sender, System.EventArgs e)
{
ToggleSoftTrigger();
}
Creates a generic ReaderData object for use with a Symbol.Barcode.Reader
object.
NOTE: This method has been deprecated and will not be supported.
Please use the Symbol.Barcode.ReaderData class to create a ReaderData object.
The Symbol.Generic base classes provide a level of abstraction for data providers
such as Barcode Readers and Magnetic Stripe Readers. This abstraction provides
application developers with the capability to write generic code that can be
used across different data providers and hardware. Since only common
functionality is provided by the Generic classes, some specific features may
be lost.
A generic ReaderData object.
All changes in decoder parameters, reader parameters, UPCEAN parameters, Scanner parameters
and Interface parameters will be applied to the barcode that will be read immediately.
NOTE: Beginning with the ScanMDD file version 6.01, the InterfaceParameters object can be accessed before or after enabling the
Reader object. In the earlier versions of ScanMDD, the InterfaceParameters 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.
If this function is not called after making modifications to any of these
parameters, then the changes would take effect only after the completion of any
pending reads.
Get decoder parameters, reader parameters, interface parameters, UPCEAN parameters and Scanner parameters from the
underlying API.
NOTE: Beginning with the ScanMDD file version 6.01, the InterfaceParameters object can be accessed before or after enabling the
Reader object. In the earlier versions of ScanMDD, the InterfaceParameters 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.
Provides Beep and/or LED feedback on the remote scanner.
RemoteFeedbackParams object that contains the feedback parameters
This feature is available only on remote scanners with feedback capabilites like RS507.
To determine if this feature is available check the IsFeedbackSupported property in Reader.Info object.
Start status monitoring thread
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 IsFeedbackSupported property in Reader.Info 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.
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
The class for the RSM (Remote Scanner Management) 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.
// Create the Barcode Reader object using the first available scanner
private Symbol.Barcode.Reader MyReader = null;
MyReader = new Symbol.Barcode.Reader();
// Enable the Reader
MyReader.Actions.Enable();
// Read the current and factory default values of the model number attribute
string txtModelNumber = MyReader.RSM.ModelNumber.CurrentValue;
string txtFdfltModelNumber = MyReader.RSM.ModelNumber.FactoryDefaultValue;
// Read the status of the Bluetooth encryption
bool bBTEncryption = MyReader.RSM.BluetoothEncryption.CurrentValue;
// Check if the PIN code attribute is supported and modify it
if (MyReader.RSM.BluetoothPINCode.IsSupported)
{
MyReader.RSM.BluetoothPINCode.CurrentValue = "12346";
}
// Disable the Reader object
MyReader.Actions.Disable();
// Dispose the Reader object
MyReader.Dispose();
' Create the Barcode Reader object using the first available scanner
Dim MyReader As Symbol.Barcode.Reader = Nothing
MyReader = New Symbol.Barcode.Reader()
' Enable the Reader
MyReader.Actions.Enable()
' Read the current and factory default values of the model number attribute
Dim txtModelNumber As String = MyReader.RSM.ModelNumber.CurrentValue
Dim txtFdfltModelNumber As String = MyReader.RSM.ModelNumber.FactoryDefaultValue
' Write the Bluetooth PIN code
Dim bBTEncryption As Boolean = MyReader.RSM.BluetoothEncryption.CurrentValue
' Check if the PIN code attribute is supported and modify it
If MyReader.RSM.BluetoothPINCode.IsSupported Then
MyReader.RSM.BluetoothPINCode.CurrentValue = "12346"
End If
' Disable the Reader object
MyReader.Actions.Disable()
' Dispose the Reader object
MyReader.Dispose()
The constructor.
Provides a list of supported RSM 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 "rsmPreferredWirelessHost" 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 "rsmHardwareVersion" 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.
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 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 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.
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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 battery capacity.
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 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 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 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 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 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 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 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 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 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)
Barcode reader version class.
Version class constructor
The Reader object to obtain version information from.
Version of scanner hardware if applicable
Version of decoder software if applicable
Version of the scanner driver PDD.
Version of the scanner driver MDD.
Version of the scanner native API.
Version of the Assembly.
The InterfaceParams 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 InterfaceParameters object can be accessed before or after enabling the
Reader object. In the earlier versions of ScanMDD, the InterfaceParameters 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.
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.
Enumerates the supported interface types.
QSNAC Interface
SSI Interface
LS48XX Interface
Lighthouse Interface
Camscan Interface
The InterfaceSpecific holds parameters for one interface type.
The parameter values in InterfaceSpecific depends on the interface type.
Provides the QSNAC specific interface parameters
Provides the SSI specific interface parameters
Provides the LS48XX specific interface parameters
Provides the Lighthouse specific interface parameters
Provides the CamScan specific interface parameters
Provides the QSNAC specific interface parameters
Time in milliseconds after engine is enabled before the laser is turned on.
Flag to enable decoding of inverse labels.
The white data logic level of the scanner device.
Sampling clock divisor used for data acquisition.
Possible values are 1 to 32 inclusive.
Time in milliseconds after power is supplied before engine is ready for use.
NOTE: Changing the default value is not recommended.
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 LS48XX specific interface parameters
Time in milliseconds after power is supplied before engine is ready for use.
NOTE: Changing the default value is not recommended.
Provides the Lighthouse 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 in milliseconds after engine is enabled before the laser is turned on.
Time in milliseconds of non-use before dropping to a low-power mode.
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.
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.
Pointer label type.
Image label type.
Signature label type.
RESERVED.
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
MATRIX_2OF5 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 or labeltype is unknown.
Data types 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 ReaderData 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 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 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.
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.
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)
UPC class provides a level of abstraction for UPC specific parameters.
The UPC class provides enumerated types that are specific to this
symbology.
Controls the preamble applied to the bar code.
No preamble
System character preamble.
Both country and system code preamble.
UPCE0 class is inherited from UPC and provides UPC specific enumerated types.
UPCE1 class is inherited from UPC and provides UPC specific enumerated types.
UPCEA class is inherited from UPC and provides UPC specific enumerated types.
MSI class provides a level of abstraction for MSI specific parameters.
The MSI class provides enumerated types that are specific to this
symbology.
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.
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.
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.
UPCEAN class provides a level of abstraction for specific enumerated types.
The UPC/EAN security level.
No UPC/EAN security. This has been deprecated. Please use the value LEVEL0 instead.
Check ambiguous characters. This has been deprecated. Please use the value LEVEL1 instead.
Check all characters. This has been deprecated. Please use the value LEVEL2 instead.
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
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.
COMPOSITE_AB class provides a level of abstraction for specific enumerated types.
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
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.
Contact wand bar code reader.
Imager bar code reader.
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. (Can be overridden if PicklistMode is set to True).
Dot aiming.
Slab aiming
Reticle aiming
Describes the type of vertical rastering to use.
No rastering.
Rastering always full open.
Smart rastering mode.
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.
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
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
List of beam widths supported for the laser beam
Normal beam width
Narrow beam width
Wide beam width
CODE39 class 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 class 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
Supported feedback types
Provides remote feedback if scanner supports it
Provides local feedback only. Default value
Provides local as well as remote feedback
Used for enabling or disabling the adaptive scanning mode.
Disables adaptive mode.
Enables adaptive mode.
Enable or disable LCD mode (for Blockbuster imager devices only).
Disables the LCD mode
Enables LCD mode
The Barcode.Reader class can be considered the primary class of the Barcode class
library. It provides access to actions, information, and parameters.
The Reader class provides all the capabilities of the scanner. It is normally constructed
by having a object passed in as a parameter. Once created,
actions can be performed on the reader using object returned from the
property. One of the most commonly used actions is the
submitting of a request. To perform a Read you will need to
contruct a object and pass it as a parameter to the
Read method. You will then need to attach to the event
to be notified when a read completes. Decoder and scan parameter objects can be
access using the Reader.Decoders and Reader.Parameters properties, respectively.
The Dispose method of the Reader should be called when the object is no
longer needed by the application.
Default Reader constructor creates an instance using the first available device.
The first available device may be a Simulated device if no scanning hardware is
found. To be sure that the correct device is targeted during the instantiation of
the Reader, it is suggested that you specify the Device fully using the other
Reader constructors.
Reader constructor with settable device name.
A string that contains the device name of the hardware
to access. This is normally of the form "SCNx:", where the x is the number of the
scanner.
Reader constructor with settable Barcode.Device.
This is the recommended constructor to use when creating a Reader object.
A Generic.Device or object that targets a particular
scanner.
Allows a Reader to attempt to free resources and perform other cleanup
operations before it is reclaimed by garbage collection.
Frees up all resources used by the Reader, including any objects it has created.
It is strongly recommended that this method be called when the Reader is no longer
needed by the application.
Gets the next ReaderData object from the read completion queue.
The GetNextReaderData method is most commonly called by methods that have been
invoked via the ReadNotify event. This method provides access to the ReaderData
object of completed reads (whether the reads have been completed successfully or
not should be determined from the status information provided by the ReaderData
object).
A object that has completed.
Gets the next BarcodeStatus object from the scan status event queue.
The GetNextStatus method is most commonly called by methods that have been
invoked via the StatusNotify event. This method provides access to the BarcodeStatus
object that contains information about the scan event that has occured.
A object with scan event
information.
String representation of class.
The device name of the Reader in string form.
Saves the parameters so that they can be restored later if necessary.
When "true", the save procedure
will recurse into the subclasses and save their parameters as well.
(i.e. perform a deep copy).
An object that represents the saved parameters.
Restores saved parameters. The object passed as
a parameter should be obtained using the method.
An object obtained that contains the saved state
Attach to this notification event to be called back when a read completes.
A delegate of the method that will be invoked
when a read completes.
Attach to this notification event to be called back when a scan event occurs.
A delegate of the method that will be invoked
when a scan event occurs.
Provides access to actions that can be performed on the Reader.
A object.
Provides access to information about the Reader.
A object.
Provides access to version information.
A object.
Returns the name of the device being used for the Reader.
String that contains the Device name
Provides access to Decoder-specific parameters so that they can be viewed
and modified.
A object that contains the decoders.
Provides access to scan-specific parameters so that they can be viewed
and modified.
A object that contains the scan parameters.
Provides access to Reader-specific parameters so that they can be viewed
and modified.
A object that contains the reader parameters.
Provides access to UPC/EAN-specific parameters so that they can be viewed
and modified.
A object that contains the parameters.
Provides access to RSM (Remote Scanner Management) attributes so that they can be viewed
and modified. The Reader must be enabled before accessing RSM attributes.
NOTE: The RSM feature can only be used when using remote scanner devices such as RS507.
Provides access to Interface-specific parameters so that they can be viewed
and modified.
NOTE: Beginning with the ScanMDD file version 6.01, the InterfaceParameters object can be accessed before or after enabling the
Reader object. In the earlier versions of ScanMDD, the InterfaceParameters 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.
The READER_PARAMS 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.
Sub-structure describing memory allocated and used by this structure.
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 Constructor for ReaderParams
Sub-structure describing memory allocated and used by this structure.
The constructor should not normally be called
The ReaderSpecific holds parameters for one reader type.
The structure of ReaderSpecific depends on the value of ReaderType.
The LASER_SPECIFIC class holds laser specific reader parameters.
The CONTACT_SPECIFIC class holds contact wand specific reader parameters.
The IMAGER_SPECIFIC class holds imager specific reader parameters.
The constructor should not normally be called
The LASER_SPECIFIC class holds laser specific reader parameters.
The constructor should not normally be called
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 is no longer supported.
It will be removed in a future release.
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.
Flag to enable narrow beam width.
NOTE: This property is being deprecated. It will be removed from a future version.
Please use the BeamWidth property instead.
Allows the user to set the width of the laser beam.
NOTE: User can query the Reader.Info.SupportedBeamWidths property
to see what beam widths are supported on the device.
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 Reader.Info.AdaptiveScanning 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 CONTACT_SPECIFIC class holds contact wand specific reader parameters.
The constructor should not normally be called
Quiet zone ratio x:1 to 1:x used for decoding.
Time in milliseconds that contact wand will remain in acquire mode waiting for a bar code.
Time in milliseconds to pause between pulses of the contact wand.
The IMAGER_SPECIFIC class holds imager specific reader parameters.
The constructor should not normally be called
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/reticule (+) part of the AIM pattern. 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, PicklistMode will override AimMode if
no aiming is chosen and use the AIM_MODE_RETICLE mode. When enabled, PicklistMode may adversely
affect overall decoding performance.
ENABLE – Enables picklist mode, so only the barcode under the cross-hair can be decoded.
DISABLE – Disables picklist mode, so any barcode within the field of view can be decoded.
When both PicklistMode and PicklistModeEx are set by the user, PicklistModeEx takes precedance over PicklistMode.
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.
When both PicklistMode and PicklistModeEx are set by the user, PicklistModeEx takes precedance over PicklistMode.
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.
NOTE: The VFPosition property can be modified by assigning a new Rectangle object containing
the necessary Left, Top, Right and Bottom values. Please refer the example section below for code snippets.
Symbol.Barcode.Rectangle rect = new Symbol.Barcode.Rectangle();
rect.Left = 20;
rect.Top = 20;
rect.Right = 50;
rect.Bottom = 50;
myReader.ReaderParameters.ReaderSpecific.ImagerSpecific.VFPosition = rect;
myReader.Actions.SetParameters();
Dim rect As New Symbol.Barcode.Rectangle()
rect.Left = 20
rect.Top = 20
rect.Right = 50
rect.Bottom = 50
myReader.ReaderParameters.ReaderSpecific.ImagerSpecific.VFPosition = rect
myReader.Actions.SetParameters()
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 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.
The Symbol.Barcode.Device class provides information about to all the
available scanners in the system.
The Symbol.Barcode.Device class provides an excellent starting point for applications
that wish to gain more information about all the scanners available. The
AvailableDevices property provides a static Device array with each entry mapping to
available scanning hardware. Each entry contains information about the hardware and
can also be used to contruct a object. This is the
recommended method for instantiating Reader objects.
Default device class constructor.
By default, a Barcode.Device object will be contructed with the "SCN1:" scanner
targeted. Its friendly name will be "Default Reader".
Device class constructor with settable device name.
A Barcode.Device object will be contructed with the given Device Name. Its
friendly name will be "Explicit Reader".
The name of the device (should be in the form "SCNx:",
where the x is the number of the scanner).
Device class constructor with settable device name and friendly name.
A Barcode.Device object will be contructed with the given Device Name and Friendly
Name.
The name of the device (should be in the form "SCNx:",
where the x is the number of the scanner).
A friendly name for the device. Can be any string.
Static title of the barcode device class.
A String that returns "Barcode".
The AvailableDevices property can be used to obtain a list of all available
hardware for use with the barcode classes.
The AvailableDevices property provides a static Device array with each entry
mapping to available scanning hardware. Each entry contains information about
the hardware and can also be used to contruct a
object. This is the recommended method for instantiating Reader objects.
A array that represents all available scanning hardware.
Provides the scanner device type information. This information is retrieved when the device is enumerated using AvailableDevices[] property.
Provides the scanner device type information. This information is retrieved when the device is enumerated using AvailableDevices[] property.
Specifies the type of scanner.
Specifies the transport type used by the scanner.
The BarcodeStatus class provides access to notification information.
The BarcodeStatus class is normally obtained from the
method. The GetNextStatus() method is usually called when a StatusNotify event
has been fired and your event processing method (EventHandler) has been invoked.
During your event processing the BarcodeStatus object is obtained so that
information about the status change can be retrieved.
The BarcodeStatus constructor is not normally called by the developer.
An EventTypes enumerated type that defines the type of
event that has occurred.
A States enumerated type that defines the new state of
the Reader.
The state of the Reader in string form.
Retrieves the Barcode Reader event type.
An EventTypes member that defines the type of event that has occured.
Retrieves the Barcode.Reader event state.
A State member that defines the new state of the Reader.
Retrieves the Barcode.Reader state in string form.
The string representation of the Barcode.Reader state.
ReaderData class encapsulates all the scanned data and meta-data for a given read.
The ReaderData class is most commonly used to create objects that will be passed to the
method. This will start a pending read.
ReaderData constructor with integer based buffer size.
A member that specifies
whether the memory buffer sent to the hardware will hold text or raw binary data.
An integer that specifies the size of the memory buffer
in bytes for binary mode, in characters for text mode.
ReaderData constructor with enumerated type buffer size.
A member that specifies
whether the memory buffer sent to the hardware will hold text or raw binary data.
An integer that specifies the size of the memory buffer
in bytes for binary mode, in characters for text mode.
Allows a ReaderData to attempt to free resources and perform other cleanup
operations before it is reclaimed by garbage collection.
Release all resources used by ReaderData object.
It is highly recommended that this method be called when the ReaderData object is no
longer being used by the application. Note: Do not Dispose of the ReaderData
object until any Reads associated with it have been cancelled.
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.
Specifies whether or not the ReaderData 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 the ReaderData is currently in a pending read situation.
A boolean flag which when true indicate that the ReaderData has not completed a
read that has been requested of it. Reads will be pending until they complete
with a valid decode, fail with an error, or are cancelled.
Specifies whether or not a memory buffer has been allocated for the ReaderData.
The memory buffer will be allocated after a read is issued using the Reader.Actions.Read(..) call.
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 ReaderData.
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.
Returns a byte array with the scanned data.
A byte array with the scanned data if the ReaderDataType has been set to binary mode.
An InvalidDataTypeException
is thrown if this property is accessed and ReaderDataType has been set
to text mode in the constructor of ReaderData 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 Decoder Type of the barcode in hexadecimal format.
A string of the form "0x#", where # is the decoder type in hexadecimal.
The length of the barcode data.
An integer that specifies the length of the scanned data.
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.
Provides the access to the auxiliary data.
The auxiliary data will be avaialble only if the flag MultiPart is true.
Not currently used, returns either "Scan Complete" or "".
Specifies whether or not the ReaderData has been attached to a Reader object via
a Actions.Read method call.
Note: This property will return true after a read has completed.
A boolean flag that when set to true indicates that the ReaderData has been attached
to a Reader at some point.
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.
Provides the access to the auxiliary data.
This is meant to be used in conjunction with a ReaderData instance.
Returns the auxiliary data text.
A string of the auxiliary data if the ReaderData memory buffer has been set to text mode.
An
InvalidDataTypeException is thrown if this property is accessed and the ReaderData
memory buffer has been set to binary mode.
Returns the auxiliary data text.
A string of the auxiliary data if the ReaderData memory buffer has been set to text mode.
An
InvalidDataTypeException is thrown if this property is accessed and the ReaderData
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 ReaderData memory buffer has been set to binary mode.
An InvalidDataTypeException
is thrown if this property is accessed and ReaderDataType has been set
to text mode in the constructor of ReaderData object.
The length of the auxiliary data.