Intermec Technologies ABTM3-3 User Manual

Exhibit L: User Manual - Part 2 of 2
FCC ID: HN2ABTM3-3
Scanner SupportChapter 6
Code 128 Enumerations
typedef enum tagCode128Decoding { ITC_CODE128_NOTACTIVE = 0, // Default ITC_CODE128_ACTIVE = 1, ITC_CODE128_NO_CHANGE = 255 } ITC_CODE128_DECODING; typedef enum tagEan128Identifier { ITC_EAN128_ID_REMOVE, ITC_EAN128_ID_INCLUDE, // Default ITC_EAN128_ID_NO_CHANGE = 255 } ITC_EAN128_IDENTIFIER; typedef enum tagCode128Cip128 { ITC_CODE128_CIP128_NOTACTIVE = 0, // Default ITC_CODE128_CIP128_ACTIVE = 1, ITC_CODE128_CIP128_NO_CHANGE = 255 } ITC_CODE128_CIP128;
#define ITC_CODE128_FNC1_NO_CHANGE 255. This definition can be used when the Code128 FNC1 does not require any change.
#define ITC_BC_LENGTH_NO_CHANGE 255. This definition can be used when the bar code length does not require any change.
The table below shows what to be expected for EAN 128 labels for various symbology identifier transmit configurations and EAN 128 Identifier op­tions.
Setup Application’s Expected Result
EAN 128 ]C1 ID Symbology ID option EAN 128 Label Other Labels
1 Include ]C1 Disabled <data> <data>
2Remove]C1 Disabled <data> <data>
3 Include ]C1 AIM ID Transmitted ]C1<data> ]XY<data>
4Remove]C1 AIDIDTransmitted ]C1<data> ]XY<data>
5 Include ]C1 Custom ID Transmitted Z]C1<data> Z<data>
6Remove]C1 Custom ID Transmitted Z<data> Z<data>
where “X” is the symbology identifier, “Y” is the modifier character, and “Z” is the 1-byte symbology identifier.
182 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig::GetI2of5
This function retrieves the current settings of Interleaved 2 of 5.
Syntax
HRESULT IS9CConfig::GetI2of5( ITC_INTERLEAVED2OF5_DECODING* peDecode, ITC_INTERLEAVED2OF5_CHECK_DIGIT* peCheck, ITC_BARCODE_LENGTH_ID* peLengthId, BYTE rbgLengthBuff[], DWORD* pdwNumBytes );
Parameters
peDecode [out] Pointer to the
ITC_INTERLEAVED2OF5_DECODING location to receive the decoding for Interleaved 2 of 5 symbology.
peCheck [out] Pointer to the
ITC_INTERLEAVED2OF5_CHECK_DIGIT location to receive the check digit.
peLengthId [out] Pointer to the ITC_BARCODE_LENGTH_ID
location to receive an indicator of either ITC_BARCODE_LENGTH or ITC_BARCODE_FIXED_LENGTH.
rgbLengthBuff [out,size_is(3)]
An array of bytes to receives 1 byte of data for ITC_BARCODE_LENGTH or 3 bytes of data for ITC_BARCODE_FIXED_LENGTH.
pdwNumBytes [out] Pointer to the DWORD location to receive a
number indicating number of bytes in rbgLengthBuff[]: 1 byte for ITC_BARCODE_LENGTH or 3 bytes for ITC_BARCODE_FIXED_LENGTH.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
183700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig::SetI2of5
This function updates the Interleaved 2 of 5 settings with new values.
Syntax
HRESULT IS9CConfig::SetI2of5( ITC_INTERLEAVED2OF5_DECODING eDecode, ITC_INTERLEAVED2OF5_CHECK_DIGIT eCheck, ITC_BARCODE_LENGTH_ID eLengthId, BYTE rgbLengthBuff[], DWORD
dwNumBytes );
Parameters
eDecode [in] Identifies the decoding for Interleaved 2 of 5
symbology.
eCheck [in] Identifies the check digit.
eLengthId [in] Use
ITC_BARCODE_LENGTH_NO_CHANGE to indicate no change for bar code length. Use ITC_BARCODE_LENGTH for any length and minimum length, and set rgbLengthBuff[0] to a valid length value. Use ITC_BARCODE_FIXED_LENGTH to compose 1 or 2 or 3 fixed lengths, and set 3 bytes:
rgbLengthBuff[0], rgbLengthBuff[1], rgbLengthBuff[2] with valid values.
rgbLengthBuff [in,size_is(dwNumBytes)]
Contains bar code lengths when eLengthId = Use ITC_BARCODE_LENGTH or Use ITC_BARCODE_FIXED_LENGTH.
dwNumBytes [in] Number of bytes in rbgLengthBuff[]. For S9C, this
value is 1 when eLengthId = ITC_BARCODE_LENGTH or 3 when eLengthId = ITC_BARCODE_FIXED_LENGTH.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
Interleaved 2 of 5 Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_INTERLEAVED2OF5_DECODING
Check Digit Not Used ITC_INTERLEAVED2OF5_CHECK_DIGIT
Bar Code Length Minimum Length = 6 0x00`0xFE ITC_BC_LENGTH_NO_CHANGE
184 700 Series Color Mobile Computer User’s Manual
Interleaved 2 of 5 Enumerations
typedef enum tagInterleaved2of5Decoding { ITC_INTERLEAVED2OF5_NOTACTIVE = 0, // Default ITC_INTERLEAVED2OF5_ACTIVE = 1, ITC_INTERLEAVED2OF5_NO_CHANGE = 255 } ITC_INTERLEAVED2OF5_DECODING; typedef enum tagInterleaved2of5CheckDigit { ITC_INTERLEAVED2OF5_CHECK_NOTUSED, // Default ITC_INTERLEAVED2OF5_CHECK_MOD10_XMIT, ITC_INTERLEAVED2OF5_CHECK_MOD10_NOTXMIT, ITC_INTERLEAVED2OF5_CHECK_FRENCH_CIP_XMIT, ITC_INTERLEAVED2OF5_CHECK_FRENCH_CIP_NOTXMIT, ITC_INTERLEAVED2OF5_CHECK_NO_CHANGE = 255 } ITC_INTERLEAVED2OF5_CHECK_DIGIT; typedef enum tagBarcodeLengthId { ITC_BARCODE_LENGTH = 0, ITC_BARCODE_FIXED_LENGTH, ITC_BARCODE_LENGTH_NO_CHANGE = 255 } ITC_BARCODE_LENGTH_ID;
6 Scanner SupportChapter
IS9CConfig::GetMatrix2of5
This function retrieves the current settings of Matrix 2 of 5.
Syntax
HRESULT IS9CConfig::GetMatrix2of5( ITC_MATRIX2OF5_DECODING* peDecode, DWORD* pdwLength );
Parameters
peDecode [out] Pointer to the ITC_MATRIX2OF5_DECODING
location to receive the decoding for Matrix 2 of 5 symbology.
pdwLength [out] Pointer to the DWORD location to receive a value
for the bar code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
185700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig::SetMatrix2of5
This function updates the Matrix 2 of 5 settings with new values.
Syntax
HRESULT IS9CConfig::SetMatrix2of5( ITC_MATRIX2OF5_DECODING eDecode, DWORD dwLength );
Parameters
eDecode [in] Identifies the decoding for Matrix 2 of 5 symbology.
dwLength [in] Identifies the bar code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
Matrix 2 of 5 Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_MATRIX2OF5_DECODING
Bar Code Length Minimum Length = 6 0x00`0xFE ITC_BC_LENGTH_NO_CHANGE
Matrix 2 of 5 Enumerations
typedef enum tagMatrix2of5Decoding { ITC_MATRIX2OF5_NOTACTIVE = 0, // Default ITC_MATRIX2OF5_ACTIVE = 1, ITC_MATRIX2OF5_NO_CHANGE = 255 } ITC_MATRIX2OF5_DECODING; #define ITC_BC_LENGTH_NO_CHANGE 255. This definition can be used when the bar code length does not require any change.
186 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig::GetMSI
This function retrieves the current MSI settings.
Syntax
HRESULT IS9CConfig::GetMSI( ITC_MSI_DECODING* peDecode, ITC_MSI_CHECK_DIGIT* peCheck, DWORD* pdwLength );
Parameters
peDecode [out] Pointer to the ITC_MSI_DECODING location to
receive the decoding for MSI symbology.
peCheck [out] Pointer to the ITC_MSI_CHECK_DIGIT
location to receive the check digit.
pdwLength [out] Pointer to the DWORD location to receive the bar
code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
IS9CConfig::SetMSI
This function updates the MSI settings with new values.
Syntax
HRESULT IS9CConfig::SetMSI( ITC_MSI_DECODING eDecode, ITC_MSI_CHECK_DIGIT eCheck, DWORD dwLength );
Parameters
eDecode [in] Identifies the decoding for MSI symbology. eCheck [in] Identifies the check digit. dwLength [in] Identifies the bar code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
MSI Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_MSI_DECODING
Check Digit MOD 10 checked and transmitted ITC_MSI_CHECK_DIGIT
Bar Code Length Minimum Length = 6 0x00`0xFE ITC_BC_LENGTH_NO_CHANGE
187700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
MSI Enumerations
typedef enum tagMsiDecoding { ITC_MSI_NOTACTIVE = 0, // Default ITC_MSI_ACTIVE = 1, ITC_MSI_NO_CHANGE = 255 } ITC_MSI_DECODING; typedef enum tagMsiCheckDigit { ITC_MSI_CHECK_MOD10_XMIT, // Default ITC_MSI_CHECK_MOD10_NOTXMIT, ITC_MSI_CHECK_DOUBLEMOD10_XMIT, ITC_MSI_CHECK_DOUBLEMOD10_NOTXMIT, ITC_MSI_CHECK_NO_CHANGE = 255 } ITC_MSI_CHECK_DIGIT; #define ITC_BC_LENGTH_NO_CHANGE 255. This definition can be used when the bar code length does not require any change.
IS9CConfig::GetPDF417
This function retrieves the current PDF417 settings.
Syntax
HRESULT IS9CConfig::GetPDF417( ITC_PDF417_DECODING* pePdf417Decode, ITC_PDF417_MACRO_PDF* peMacroPdf, ITC_PDF417_CTRL_HEADER* pePdfControlHeader, ITC_PDF417_FILE_NAME* pePdfFileName, ITC_PDF417_SEGMENT_COUNT* pePdfSegmentCount, ITC_PDF417_TIME_STAMP* pePdfTimeStamp, ITC_PDF417_SENDER* pePdfSender, ITC_PDF417_ADDRESSEE* pePdfAddressee, ITC_PDF417_FILE_SIZE* pePdfFileSize, ITC_PDF417_CHECKSUM*
pePdfChecksum );
Parameters
pePdf417Decode [out] Pointer to the
ITC_PDF417_DECODING location to receive the decoding for PDF417 symbology.
peMacroPdf [out] Pointer to the
ITC_PDF417_MACRO_PDF location to receive the Macro PDF.
pePdfControlHeader [out] Pointer to the
ITC_PDF417_CTRL_HEADER location to receive the control header.
pePdfFileName [out] Pointer to the
ITC_PDF417_FILE_NAME location to receive the file name.
pePdfSegmentCount [out] Pointer to the
ITC_PDF417_SEGMENT_COUNT location to receive the segment count.
pePdfTimeStamp [out] Pointer to the
ITC_PDF417_TIME_STAMP location to receive the time stamp.
188 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
pePdfSender [out] Pointer to the ITC_PDF417_SENDER
location to receive the sender.
pePdfAddressee [out] Pointer to the
ITC_PDF417_ADDRESSEE location to receive the addressee.
pePdfFileSize [out] Pointer to the ITC_PDF417_FILE_SIZE
location to receive the file size.
pePdfChecksum [out] Pointer to the
ITC_PDF417_CHECKSUM location to receive the checksum.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
IS9CConfig::SetPDF417
This function updates the PDF417 settings with new values.
Syntax
HRESULT IS9CConfig::SetPDF417( ITC_PDF417_DECODING ePdf417Decode, ITC_PDF417_MACRO_PDF eMacroPdf, ITC_PDF417_CTRL_HEADER ePdfControlHeader, ITC_PDF417_FILE_NAME ePdfFileName, ITC_PDF417_SEGMENT_COUNT ePdfSegmentCount, ITC_PDF417_TIME_STAMP ePdfTimeStamp, ITC_PDF417_SENDER ePdfSender, ITC_PDF417_ADDRESSEE ePdfAddressee, ITC_PDF417_FILE_SIZE ePdfFileSize, ITC_PDF417_CHECKSUM ePdfChecksum );
Parameters
ePdf417Decode [in] Identifies the decoding for PDF417 symbology.
eMacroPdf [in] Identifies the Macro PDF.
ePdfControlHeader [in] Identifies the control header.
ePdfFileName [in] Identifies the file name.
ePdfSegmentCount [in] Identifies the segment count.
ePdfTimeStamp [in] Identifies the time stamp.
ePdfSender [in] Identifies the sender.
ePdfAddressee [in] Identifies the addressee.
ePdfFileSize [in] Identifies the file size.
ePdfChecksum [in] Identifies the checksum.
Return Values
HRESULT that indicates success or failure.
189700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
Remarks
None.
See Also
None.
PDF 417 Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_PDF417_DECODING
Macro PDF Macro PDF Buffered ITC_PDF417_MACRO_PDF
Control Header Not Transmitted ITC_PDF417_CTRL_HEADER
*File Name Not Transmitted ITC_PDF417_FILE_NAME
*Segment Count Not Transmitted ITC_PDF417_SEGMENT_COUNT
*Time Stamp Not Transmitted ITC_PDF417_TIME_STAMP
*Sender Not Transmitted ITC_PDF417_SENDER
*Address Not Transmitted ITC_PDF417_ADDRESSEE
*File Size Not Transmitted ITC_PDF417_FILE_SIZE
*Check Sum Not Transmitted ITC_PDF417_CHECKSUM
* These are Macro PDF Optional Fields.
PDF 417 Enumerations
typedef enum tagPdf417Decoding { ITC_PDF417_NOTACTIVE = 0, ITC_PDF417_ACTIVE = 1, // Default ITC_PDF417_NO_CHANGE = 255 } ITC_PDF417_DECODING; typedef enum tagPdf417MacroPdf { ITC_PDF417_MACRO_UNBUFFERED = 0, ITC_PDF417_MACRO_BUFFERED = 1, // Default ITC_PDF417_MACRO_NO_CHANGE = 255 } ITC_PDF417_MACRO_PDF; typedef enum tagPdf417ControlHeader { ITC_PDF417_CTRL_HEADER_NOTXMIT = 0, // Default ITC_PDF417_CTRL_HEADER_XMIT = 1, ITC_PDF417_CTRL_HEADER_NO_CHANGE = 255 } ITC_PDF417_CTRL_HEADER; typedef enum tagPdf417FileName { ITC_PDF417_FILE_NAME_NOTXMIT = 0, // Default ITC_PDF417_FILE_NAME_XMIT = 1, ITC_PDF417_FILE_NAME_NO_CHANGE = 255 } ITC_PDF417_FILE_NAME; typedef enum tagPdf417SegmentCount { ITC_PDF417_SEGMENT_COUNT_NOTXMIT = 0, // Default ITC_PDF417_SEGMENT_COUNT_XMIT = 1,
190 700 Series Color Mobile Computer User’s Manual
ITC_PDF417_SEGMENT_COUNT_NO_CHANGE = 255 } ITC_PDF417_SEGMENT_COUNT;
typedef enum tagPdf417TimeStamp { ITC_PDF417_TIME_STAMP_NOTXMIT = 0, // Default ITC_PDF417_TIME_STAMP_XMIT = 1, ITC_PDF417_TIME_STAMP_NO_CHANGE = 255 } ITC_PDF417_TIME_STAMP; typedef enum tagPdf417Sender { ITC_PDF417_SENDER_NOTXMIT = 0, // Default ITC_PDF417_SENDER_XMIT = 1, ITC_PDF417_SENDER_NO_CHANGE = 255 } ITC_PDF417_SENDER; typedef enum tagPdf417Addressee { ITC_PDF417_ADDRESSEE_NOTXMIT = 0, // Default ITC_PDF417_ADDRESSEE_XMIT = 1, ITC_PDF417_ADDRESSEE_NO_CHANGE = 255 } ITC_PDF417_ADDRESSEE; typedef enum tagPdf417FileSize { ITC_PDF417_FILE_SIZE_NOTXMIT = 0, // Default ITC_PDF417_FILE_SIZE_XMIT = 1, ITC_PDF417_FILE_SIZE_NO_CHANGE = 255 } ITC_PDF417_FILE_SIZE; typedef enum tagPdf417Checksum { ITC_PDF417_CHECKSUM_NOTXMIT = 0, // Default ITC_PDF417_CHECKSUM_XMIT = 1, ITC_PDF417_CHECKSUM_NO_CHANGE = 255 } ITC_PDF417_CHECKSUM;
6 Scanner SupportChapter
191700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig::GetPlessey
This function retrieves the current Plessey settings.
Syntax
HRESULT IS9CConfig::GetPlessey( ITC_PLESSEY_DECODING* peDecode, ITC_PLESSEY_CHECK_DIGIT* peCheck, DWORD* pdwLength
);
Parameters
peDecode [out] Pointer to the ITC_PLESSEY_DECODING
location to receive the decoding for Plessey symbology.
peCheck [out] Pointer to the ITC_PLESSEY_CHECK_DIGIT
location to receive the check digit.
pdwLength [out] Pointer to the DWORD location to receive the bar
code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
IS9CConfig::SetPlessey
This function updates the Plessey settings with new values.
Syntax
HRESULT IS9CConfig::SetPlessey( ITC_PLESSEY_DECODING eDecode, ITC_PLESSEY_CHECK_DIGIT eCheck, DWORD dwLength );
Parameters
eDecode [in] Identifies the decoding for Plessey symbology.
eCheck [in] Identifies the check digit.
dwLength [in] Identifies the bar code length.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
192 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
Plessey Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_PLESSEY_DECODING
Check Digit Not Transmitted ITC_PLESSEY_CHECK_DIGIT
Bar Code Length Any Bar Code Length 0x00`0xFE ITC_BC_LENGTH_NO_CHANGE
Plessey Enumerations
typedef enum tagPlesseyDecoding { ITC_PLESSEY_NOTACTIVE = 0, // Default ITC_PLESSEY_ACTIVE = 1, ITC_PLESSEY_NO_CHANGE = 255 } ITC_PLESSEY_DECODING; typedef enum tagPlesseyCheckDigit { ITC_PLESSEY_CHECK_NOTXMIT = 0, // Default ITC_PLESSEY_CHECK_XMIT = 1, ITC_PLESSEY_CHECK_NO_CHANGE = 255 } ITC_PLESSEY_CHECK_DIGIT; #define ITC_BC_LENGTH_NO_CHANGE 255. This definition can be used when the bar code length does not require any change.
193700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig::GetStandard2of5
This function retrieves the current Standard 2 of 5 settings.
Syntax
HRESULT IS9CConfig::GetStandard2of5( ITC_STANDARD2OF5_DECODING* peDecode, ITC_STANDARD2OF5_FORMAT* peFormat, ITC_STANDARD2OF5_CHECK_DIGIT* peCheck, ITC_BARCODE_LENGTH_ID* peLengthId, BYTE rgbLengthBuff, DWORD* pdwNumBytes );
Parameters
peDecode [out] Pointer to the
ITC_STANDARD2OF5_DECODING location to receive the decoding for Standard 2 of 5 symbology.
peFormat [out] Pointer to the
ITC_STANDARD2OF5_FORMAT location to receive the format.
peCheck [out] Pointer to the
ITC_STANDARD2OF5_CHECK_DIGIT location to receive Modulo 10 check digit.
peLengthId [out] Pointer to the ITC_BARCODE_LENGTH_ID
location to receive an indicator of either ITC_BARCODE_LENGTH or ITC_BARCODE_FIXED_LENGTH.
rgbLengthBuff [out,size_is(3)]
An array of bytes to receives 1 byte of data for ITC_BARCODE_LENGTH, or 3 bytes of data for ITC_BARCODE_FIXED_LENGTH.
pdwNumBytes [out] Pointer to the DWORD location to receive a
number indicating number of bytes in rbgLengthBuff[]: 1 byte for ITC_BARCODE_LENGTH or 3 bytes for ITC_BARCODE_FIXED_LENGTH.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
194 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig::SetStandard2of5
This function updates the Standard 2 of 5 settings with new values.
Syntax
HRESULT IS9CConfig::SetStandard2of5( ITC_STANDARD2OF5_DECODING eDecode, ITC_STANDARD2OF5_FORMAT eFormat, ITC_STANDARD2OF5_CHECK_DIGIT eCheck, ITC_BARCODE_LENGTH_ID eLengthId, BYTE rgbLengthBuff[], DWORD
dwNumBytes );
Parameters
eDecode [in] Identifies the decoding for Standard 2 of 5
symbology.
eFormat [in] Identifies the format.
eCheck [in] Identifies the Modulo 10 check digit.
eLengthId [in] Use
ITC_BARCODE_LENGTH_NO_CHANGE to indicate no change for bar code length. Use ITC_BARCODE_LENGTH for any length and minimum length, and set rgbLengthBuff[0] to a valid length value. Use ITC_BARCODE_FIXED_LENGTH to compose 1 or 2 or 3 fixed lengths, and set 3 bytes:
rgbLengthBuff[0], rgbLengthBuff[1], rgbLengthBuff[2] with valid values.
rgbLengthBuff [in,size_is(dwNumBytes)]
An array of bytes containing bar code lengths when eLengthId = ITC_BARCODE_LENGTH or ITC_BARCODE_FIXED_LENGTH.
dwNumBytes [in] Number of bytes in rbgLengthBuff[]. For S9C, this
value is 1 when eLengthId = ITC_BARCODE_LENGTH or 3 when eLengthId = ITC_BARCODE_FIXED_LENGTH.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
195700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
Standard 2 of 5 Default S ettings
Parameter Default Valid Range
Decoding Not Active ITC_STANDARD2OF5_DECODING
Format Identicon (6 Start/Stop bars) ITC_STANDARD2OF5_FORMAT
Check Digit Not Used ITC_STANDARD2OF5_CHECK_DIGIT
Bar Code Length Minimum Length = 6 0x00-0xFE ITC_BC_LENGTH_NO_CHANGE
Standard 2 of 5 Enumerations
typedef enum tagStandard2of5Decoding { ITC_STANDARD2OF5_NOTACTIVE = 0, // Default ITC_STANDARD2OF5_ACTIVE = 1, ITC_STANDARD2OF5_NO_CHANGE = 255 } ITC_STANDARD2OF5_DECODING; typedef enum tagStandard2of5Format { ITC_STANDARD2OF5_FORMAT_IDENTICON, // Default ITC_STANDARD2OF5_FORMAT_COMPUTER_IDENTICS, ITC_STANDARD2OF5_FORMAT_NO_CHANGE = 255 } ITC_STANDARD2OF5_FORMAT; typedef enum tagStandard2of5CheckDigit { ITC_STANDARD2OF5_CHECK_NOTUSED, // Default ITC_STANDARD2OF5_CHECK_XMIT, ITC_STANDARD2OF5_CHECK_NOTXMIT, ITC_STANDARD2OF5_CHECK_NO_CHANGE = 255 } ITC_STANDARD2OF5_CHECK_DIGIT; typedef enum tagBarcodeLengthId { ITC_BARCODE_LENGTH = 0, ITC_BARCODE_FIXED_LENGTH, ITC_BARCODE_LENGTH_NO_CHANGE = 255 } ITC_BARCODE_LENGTH_ID;
196 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig::GetTelepen
This function retrieves the current Telepen settings.
Syntax
HRESULT IS9CConfig::GetTelepen( ITC_TELEPEN_DECODING* peDecode, ITC_TELEPEN_FORMAT* peFormat );
Parameters
peDecode [out] Pointer to the ITC_TELEPEN_DECODING
location to receive the decoding for TELEPEN symbology.
peFormat [out] Pointer to the ITC_TELEPEN_FORMAT location to
receive the format.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
IS9CConfig::SetTelepen
This function updates the Telepen settings with new values.
Syntax
HRESULT IS9CConfig::SetTelepen( ITC_TELEPEN_DECODING* eDecode, ITC_TELEPEN_FORMAT* eFormat );
Parameters
eDecode [in] Identifies the decoding for Telepen symbology.
eFormat [in] Identifies the format.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
Telepen Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_TELEPEN_DECODING
Format ASCII ITC_TELEPEN_FORMAT
197700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
Telepen Enumerations
typedef enum tagTelepenDecoding { ITC_TELEPEN_NOTACTIVE = 0, // Default ITC_TELEPEN_ACTIVE = 1, ITC_TELEPEN_NO_CHANGE = 255 } ITC_TELEPEN_DECODING; typedef enum tagTelepenDecoding { ITC_TELEPEN_FORMAT_ASCII, // Default ITC_TELEPEN_FORMAT_NUMERIC, ITC_TELEPEN_FORMAT_NO_CHANGE = 255 } ITC_TELEPEN_FORMAT;
IS9CConfig::GetUpcEan
This function retrieves the current UPC/EAN settings.
Syntax
HRESULT IS9CConfig::GetUpcEan( ITC_UPCEAN_DECODING*
upceanDecode, ITC_UPCA_SELECT* upcASelect, ITC_UPCE_SELECT* upcESelect, ITC_EAN8_SELECT* ean8Select, ITC_EAN13_SELECT* ean13Select, ITC_UPCEAN_ADDON_DIGITS* upcAddOnDigits, ITC_UPCEAN_ADDON_TWO* upcAddOn2, ITC_UPCEAN_ADDON_FIVE* upcAddOn5, ITC_UPCA_CHECK_DIGIT* upcACheck, ITC_UPCE_CHECK_DIGIT* upcECheck, ITC_EAN8_CHECK_DIGIT* ean8Check, ITC_EAN13_CHECK_DIGIT* ean13Check,
ITC_UPCA_NUMBER_SYSTEM* upcANumSystem, ITC_UPCE_NUMBER_SYSTEM* upcENumSystem, ITC_UPCA_REENCODE* upcAReencode, ITC_UPCE_REENCODE* upcEReencode, ITC_EAN8_REENCODE* ean8Reencode );
Parameters
upceanDecode [out] Pointer to the ITC_UPCEAN_DECODING
location to receive the decoding for UPC/EAN symbology.
upcASelect [out] Pointer to the ITC_UPCA_SELECT location to
receive the UPC-A selection state.
upcESelect [out] Pointer to the ITC_UPCE_SELECT location to
receive the UPC-E selection state.
ean8Select [out] Pointer to the ITC_EAN8_SELECT location to
receive the EAN-8 selection state.
ean13Select [out] Pointer to the ITC_EAN13_SELECT location
to receive the EAN-13 selection state.
upcAddOnDigits [out] Pointer to the
ITC_UPCEAN_ADDON_DIGITS location to receive the add-on digits.
upcAddOn2 [out] Pointer to the
ITC_UPCEAN_ADDON_TWO location to receive the add-on 2 digits.
upcAddOn5 [out] Pointer to the ITC_UPCEAN_ADDON_FIVE
location to receive the add-on 5 digits.
198 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
upcACheck [out] Pointer to the ITC_UPCA_CHECK_DIGIT
location to receive the UPC-A check digit.
upcECheck [out] Pointer to the ITC_UPCE_CHECK_DIGIT
location to receive the UPC-E check digit.
ean8Check [out] Pointer to the ITC_EAN8_CHECK_DIGIT
location to receive the EAN-8 check digit.
ean13Check [out] Pointer to the ITC_EAN13_CHECK_DIGIT
location to receive the EAN-13 check digit.
upcANumSystem [out] Pointer to the
ITC_UPCA_NUMBER_SYSTEM location to receive the UPC-A number system.
upcENumSystem [out] Pointer to the
ITC_UPCE_NUMBER_SYSTEM location to receive the UPC-E number system.
upcAReencode [out] Pointer to the ITC_UPCA_REENCODE
location to receive the UPC-A reencoding.
upcEReencode [out] Pointer to the ITC_UPCE_REENCODE
location to receive the UPC-E reencoding.
ean8Reencode [out] Pointer to the ITC_EAN8_REENCODE
location to receive the EAN-8 reencoding.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
199700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig::SetUpcEan
This function updates the UPC/EAN settings with new values.
Syntax
HRESULT IS9CConfig::SetUpcEan( ITC_UPCEAN_DECODING
upceanDecode, ITC_UPCA_SELECT upcASelect, ITC_UPCE_SELECT upcESelect, ITC_EAN8_SELECT ean8Select, ITC_EAN13_SELECT ean13Select, ITC_UPCEAN_ADDON_DIGITS upcAddOnDigits, ITC_UPCEAN_ADDON_TWO upcAddOn2, ITC_UPCEAN_ADDON_FIVE upcAddOn5, ITC_UPCA_CHECK_DIGIT upcACheck, ITC_UPCE_CHECK_DIGIT upcECheck, ITC_EAN8_CHECK_DIGIT ean8Check, ITC_EAN13_CHECK_DIGIT ean13Check, ITC_UPCA_NUMBER_SYSTEM upcANumSystem, ITC_UPCE_NUMBER_SYSTEM upcENumSystem, ITC_UPCA_REENCODE upcAReencode, ITC_UPCE_REENCODE upcEReencode, ITC_EAN8_REENCODE ean8Reencode );
Parameters
upceanDecode [in] Identifies the decoding for UPC/EAN symbology.
upcASelect [in] Identifies the UPC-A selection state.
upcESelect [in] Identifies the UPC-E selection state.
ean8Select [in] Identifies the EAN-8 selection state.
ean13Select [in] Identifies the EAN-13 selection state.
upcAddOnDigits [in] Identifies the Add-on digits.
upcAddOn2 [in] Identifies the Add-on 2 digits.
upcAddOn5 [in] Identifies the Add-on 5 digits.
upcACheck [in] Identifies the UPC-A check digit.
upcECheck [in] Identifies the UPC-E check digit.
ean8Check [in] Identifies the EAN-8 check digit.
ean13Check [in] Identifies the EAN-13 check digit.
upcANumSystem [in] Identifies the UPC-A number system.
upcENumSystem [in] Identifies the UPC-E number system.
upcAReencode [in] Identifies the UPC-A reencoding.
upcEReencode [in] Identifies the UPC-E reencoding.
ean8Reencode [in] Identifies the EAN-8 reencoding.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
200 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
UPC/EAN Default Settings
Parameter Default Valid Range
Decoding ITC_UPCEAN_NO_CHANGE This parameter is no longer used, set it to this value.
UPC-A Active ITC_UPCA_SELECT
UPC-E Active ITC_UPCE_SELECT
EAN-8 Active ITC_EAN8_SELECT
EAN-13 Active ITC_EAN13_SELECT
Add On Digits Not Required ITC_UPCEAN_ADDON_DIGITS
Add On 2 Digits Not Active ITC_UPCEAN_ADDON_TWO
Add On 5 Digits Not Active ITC_UPCEAN_ADDON_FIVE
UPC-A Check Digit Transmitted ITC_UPCA_CHECK_DIGIT
UPC-E Check Digit Transmitted ITC_UPCE_CHECK_DIGIT
EAN-8 Check Digit Transmitted ITC_EAN8_CHECK_DIGIT
EAN-13 Check Digit Transmitted ITC_EAN13_CHECK_DIGIT
UPC-A Number System Transmitted ITC_UPCA_NUMBER_SYSTEM
UPC-E Number System Transmitted ITC_UPCE_NUMBER_SYSTEM
Reencode UPC-A UPC-A transmitted as EAN-13 ITC_UPCA_REENCODE
Reencode UPC-E UPC-E transmitted as UPC-E ITC_UPCE_REENCODE
Reencode EAN-8 EAN-8 transmitted as EAN-8 ITC_EAN8_REENCODE
UPC/EAN Enumerations
typedef enum tagUpcEanDecoding { ITC_UPCEAN_NOTACTIVE = 0, ITC_UPCEAN_ACTIVE = 1, // Default ITC_UPCEAN_NO_CHANGE = 255 } ITC_UPCEAN_DECODING; typedef enum tagUpcASelect { ITC_UPCA_DEACTIVATE, ITC_UPCA_ACTIVATE, // Default ITC_UPCA_NO_CHANGE = 255 } ITC_UPCA_SELECT; typedef enum tagUpcESelect { ITC_UPCE_DEACTIVATE, ITC_UPCE_ACTIVATE, // Default ITC_UPCE_NO_CHANGE = 255 } ITC_UPCE_SELECT; typedef enum tagEan8Select { ITC_EAN8_DEACTIVATE, ITC_EAN8_ACTIVATE, // Default ITC_EAN8_NO_CHANGE = 255 } ITC_EAN8_SELECT; typedef enum tagEan13Select { ITC_EAN13_DEACTIVATE,
201700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
ITC_EAN13_ACTIVATE, // Default ITC_EAN13_NO_CHANGE = 255 } ITC_EAN13_SELECT; typedef enum tagUpcEanAddonDigits { ITC_UPCEAN_ADDON_NOT_REQUIRED, // Default ITC_UPCEAN_ADDON_REQUIRED, ITC_UPCEAN_ADDON_NO_CHANGE = 255 } ITC_UPCEAN_ADDON_DIGITS; typedef enum tagUpcEanAddonTwo { ITC_UPCEAN_ADDON_TWO_NOTACTIVE = 0, // Default ITC_UPCEAN_ADDON_TWO_ACTIVE = 1, ITC_UPCEAN_ADDON_TWO_NO_CHANGE = 255 } ITC_UPCEAN_ADDON_TWO; typedef enum tagUpcEanAddonFive { ITC_UPCEAN_ADDON_FIVE_NOTACTIVE = 0, // Default ITC_UPCEAN_ADDON_FIVE_ACTIVE = 1, ITC_UPCEAN_ADDON_FIVE_NO_CHANGE = 255 } ITC_UPCEAN_ADDON_FIVE; typedef enum tagUpcACheckDigit { ITC_UPCA_CHECK_NOTXMIT = 0, ITC_UPCA_CHECK_XMIT = 1, // Default ITC_UPCA_CHECK_NO_CHANGE = 255 } ITC_UPCA_CHECK_DIGIT; typedef enum tagUpcECheckDigit { ITC_UPCE_CHECK_NOTXMIT = 0, ITC_UPCE_CHECK_XMIT = 1, // Default ITC_UPCE_CHECK_NO_CHANGE = 255 } ITC_UPCE_CHECK_DIGIT; typedef enum tagEan8CheckDigit { ITC_EAN8_CHECK_NOTXMIT = 0, ITC_EAN8_CHECK_XMIT = 1, // Default ITC_EAN8_CHECK_NO_CHANGE = 255 } ITC_EAN8_CHECK_DIGIT; typedef enum tagEan13CheckDigit { ITC_EAN13_CHECK_NOTXMIT = 0, ITC_EAN13_CHECK_XMIT = 1, // Default ITC_EAN13_CHECK_NO_CHANGE = 255 } ITC_EAN13_CHECK_DIGIT; typedef enum tagUpcANumberSystem { ITC_UPCA_NUM_SYS_NOTXMIT = 0, ITC_UPCA_NUM_SYS_XMIT = 1, // Default ITC_UPCA_NUM_SYS_NO_CHANGE = 255 } ITC_UPCA_NUMBER_SYSTEM; typedef enum tagUpcENumberSystem { ITC_UPCE_NUM_SYS_NOTXMIT = 0, ITC_UPCE_NUM_SYS_XMIT = 1, // Default ITC_UPCE_NUM_SYS_NO_CHANGE = 255 } ITC_UPCE_NUMBER_SYSTEM; typedef enum tagUpcAReencode {
202 700 Series Color Mobile Computer User’s Manual
ITC_UPCA_XMIT_AS_EAN13, // Default ITC_UPCA_XMIT_AS_UPCA, ITC_UPCA_XMIT_NO_CHANGE = 255 } ITC_UPCA_REENCODE; typedef enum tagUpcEReencode { ITC_UPCE_XMIT_AS_UPCE, // Default ITC_UPCE_XMIT_AS_UPCA, ITC_UPCE_XMIT_NO_CHANGE = 255 } ITC_UPCE_REENCODE; typedef enum tagEan8Reencode { ITC_EAN8_XMIT_AS_EAN8, //Default ITC_EAN8_XMIT_AS_EAN13, ITC_EAN8_XMIT_NO_CHANGE = 255 } ITC_EAN8_REENCODE;
6 Scanner SupportChapter
203700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig2 Functions
This interface is derived from the IS9CConfig interface and provides addi­tional methods that can be used to set and retrieve the 700 Series Comput­er’ s bar code configuration. All supported symbologies are initialized to their defaults when the S9C firmware is loaded.
GET/SET functions use enumerations as their parameters. In most enu­merations, there is an enumerator xx_NO_CHANGE (such as ITC_CODE39_NO_CHANGE), where xx refers to a particular enum­eration. This enumerator can be used during a call to a SET to indicate that no change is to be made to that particular parameter. This prevents the called function from having to format the same S9C command and send it down to the scanner.
To specify a bar code length of “any length,” use a value of “0” for the bar code length argument.
IS9CConfig2 functions are the following. IS9CCONFIG.H is the header file and ITCUUID.LIB contains the IID_IADC Interface GUID value used to obtain the interface.
S IS9CConfig2::GetCode11 (page 205)
S IS9CConfig2::SetCode11 (page 205)
S IS9CConfig2::GetCustomSymIds (page 207)
S IS9CConfig2::SetCustomSymIds (page 208)
S IS9CConfig2::GetGlobalAmble (page 211)
S IS9CConfig2::SetGlobalAmble (page 212)
S IS9CConfig2::GetPDF417Ext (page 213)
S IS9CConfig2::SetPDF417Ext (page 213)
S IS9CConfig2::GetSymIdXmit (page 214)
S IS9CConfig2::SetSymIdXmit (page 214)
204 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig2::GetCode11
This function retrieves the current settings for Code 11.
Syntax
HRESULT GetCode11( ITC_CODE11_DECODING* peDecode, ITC_CODE11_CHECK_DIGIT* peCheck, ITC_CODE11_CHECK_VERIFICATION* peVer );
Parameters
peDecode [out] Pointer to ITC_CODE11_DECODING location to
receive Code 11 decoding.
peCheck [out] Pointer to ITC_CODE11_CHECK_DIGIT location
to receive the check digit option.
peVer [out] Pointer to
ITC_CODE11_CHECK_VERIFICATION location to receive the check verification option.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
IS9CConfig2::SetCode11
This function updates the current setting of Code 11 symbology.
Syntax
HRESULT SetCode11( ITC_CODE11_DECODING eDecode, ITC_CODE11_CHECK_DIGIT eCheck, ITC_CODE11_CHECK_VERIFICATION
eVer );
Parameters
eDecode [in] An enumeration that identifies decoding option for
Code 11.
eCheck [in] An enumeration that identifies the check digit option.
eVer [in] An enumeration that identifies check verification option.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
205700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
Code 11 Default Settings
Parameter Default Valid Range
Decoding Not Active ITC_CODE11_DECODING
Check Verification 1 Digit ITC_CODE11_CHECK_VERIFICATION
Check Digit Enable ITC_CODE11_CHECK_DIGIT
Code 11 Enumerations
typedef enum tagCode11Decoding { ITC_CODE11_NOTACTIVE = 0, ITC_CODE11_ACTIVE = 1, // Default ITC_CODE11_NO_CHANGE = 255 } ITC_CODE11_DECODING; typedef enum tagCode11CheckVerification { ITC_CODE11_CHK_VERIFY_ONEDIGIT = 1, ITC_CODE11_CHK_VERIFY_TWODIGIT = 2, // Default ITC_CODE11_CHK_VERIFY_NO_CHANGE = 255 } ITC_CODE11_CHECK_VERIFICATION; typedef enum tagCode11CheckDigit { ITC_CODE11_CHECK_NOTXMIT = 0, // Default ITC_CODE11_CHECK_XMIT = 1, ITC_CODE11_CHECK_NO_CHANGE = 255 } ITC_CODE11_CHECK_DIGIT;
206 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
IS9CConfig2::GetCustomSymIds
This function retrieves all the custom symbology identifiers defined for the currently supported symbologies. This is not supported when using an imag-
er on the 700 Series Computer.
Syntax
HRESULT GetCustomSymIds( ITC_CUST_SYM_ID_PAIR* pStructSymIdPair,DWORD dwMaxNumElement, DWORD* pdwNumElement
);
Parameters
pStructSymIdPair [out] Pointer to ITC_CUST_SYM_ID_PAIR
location to receive the current defined symbology identifiers for the supported symbologies. The caller must preallocate this buffer with dwMaxNumElement elements.
dwMaxNumElement [in] Maximum number of elements allocated
for the pStructSymIdPair buffer which should always be equal to the last defined enumeration constant + 1 of the enumeration ITC_CUSTOM_ID. In this case, it is ITC_CUSTOMID_LAST_ELEMENT.
pdwNumElement [out] Pointer to DWORD location to receive
the actual number of elements returned in the pStructSymIdPair buffer, which should be the same as dwMaxNumElement.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
S Custom Identifier Assignments (page 209)
S Custom Identifier Example (page 210)
S Custom Identifier Default Settings (page 210)
207700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
IS9CConfig2::SetCustomSymIds
This function updates the symbology identifiers (any ASCII values) for the currently supported symbologies. This is not supported when using an imag-
er on the 700 Series Computer.
Syntax
HRESULT SetCustomSymIds( ITC_CUST_SYM_ID_PAIR* pStructSymIdPair, DWORD dwNumElement );
Parameters
pStructSymIdPair [in] Pointer to ITC_CUST_SYM_ID_PAIR
location, containing the new symbology identifiers for any supported symbologies to update.
dwNumElement [in] Identifies the number of symbology identifiers
to update in the pStructSymIdPair buffer.
Return Values
HRESULT that indicates success or failure.
Remarks
None.
See Also
None.
208 700 Series Color Mobile Computer User’s Manual
6 Scanner SupportChapter
Custom Identifier Assignments
Each custom identifier is a one byte ASCII value within the range from 0x00 to 0xff. The enumerations in the ITC_CUSTOM_ID enumerator can be used as symbology identifications in the GetCustomSymIds() and SetCustomSymIds() functions.
typedef enum tagCustomId { ITC_CUSTOMID_CODABAR = 0 Identifies the Codabar symbology ITC_CUSTOMID_CODE39 Identifies the Code 39 symbology ITC_CUSTOMID_CODE93 Identifies the Code 93 symbology ITC_CUSTOMID_CODE128_EAN_128 Identifies the Code 128 symbology ITC_CUSTOMID_EAN8 Identifies the EAN-8 symbology ITC_CUSTOMID_EAN13 Identifies the EAN-13 symbology ITC_CUSTOMID_I2OF5 Identifies the Interleaved 2 of 5 symbology ITC_CUSTOMID_MATRIX2OF5 Identifies the Matrix 2 of 5 symbology ITC_CUSTOMID_MSI Identifies the MSI symbology ITC_CUSTOMID_PDF417 Identifies the PDF 417 symbology ITC_CUSTOMID_PLESSEY Identifies the Plessey symbology ITC_CUSTOMID_CODE2OF5 Identifies the Standard 2 of 5 symbology ITC_CUSTOMID_TELEPEN Identifies the Telepen symbology ITC_CUSTOMID_UPCA Identifies the UPC-A symbology ITC_CUSTOMID_UPCE Identifies the UPC-E symbology ITC_CUSTOMID_CODE11 Identifies the Code 11 symbology ITC_CUSTOMID_LAST_ELEMENT Identifies the last element. Use to preallocate the buffer on GetCustomSymIds }ITC_CUSTOM_ID; typedef struct tagCustSymbIdPair {
ITC_CUSTOM_ID eSymbology; Identifies the symbology of interest
BYTE byteId;
ASCII value (1 byte within the range0x00 – 0xf)
}ITC_CUST_SYM_ID_PAIR;
209700 Series Color Mobile Computer User’s Manual
Scanner SupportChapter 6
Custom Identifier Default Settings
Symbology Default Valid Range
Codabar D0x00-0xFF
Code 11 * 0x00-0xFF
Code 39 *0x00-0xFF
Code 93 D 0x00-0xFF
Code128/EAN 128 D0x00-0xFF
EAN-8 0xFF 0x00-0xFF
EAN-13 F0x00-0xFF
Interleaved 2 of 5 I 0x00-0xFF
Matrix 2 of 5 D0x00-0xFF
MSI D 0x00-0xFF
PDF 417 *0x00-0xFF
Plessey D 0x00-0xFF
Standard 2 of 5 D0x00-0xFF
Tel e p e n * 0x00-0xFF
UPC-A A0x00-0xFF
UPC-E E 0x00-0xFF
Custom Identifier Example
The following code segment is an example of updating the UPC-E and UPC-A symbology identifiers with new values, and then retrieving the currently defined symbology identifiers for all the supported symbologies:
ITC_CUST_SYM_ID_PAIR oStructSymIdPair [ITC_CUSTOMID_LAST_ELEMENT]; oStructSymIdPair[0].eSymbology = ITC_CUSTOMID_UPCE; oStructSymIdPair[0].byteId = 0x41; // ASCII char A oStructSymIdPair[1].eSymbology = ITC_CUSTOMID_UPCA; oStructSymIdPair[1].byteId = 0x42; // ASCII char B HRESULT hr = pIS9CConfig2->SetCustomSymIds(&oStructSymIdPair[0], 2]; DWORD dwNum = 0; HRESULT hr = pIS9CConfig2->GetCustomSymIds(&oStructSymIdPair[0], ITC_CUSTOMID_LAST_ELEMENT, &dwNum);
210 700 Series Color Mobile Computer User’s Manual
Loading...
+ 189 hidden pages