IMAGETEAM™ 4X00 Series For Adaptus Imaging Technology Imagers: IT4000, IT4100, and IT4300 Software Development Kit (SDK) User’s Guide
Disclaimer Hand Held Products, Inc. d/b/a Hand Held Products (“Hand Held Products”) reserves the right to make changes in specifications and other information contained in this document without prior notice, and the reader should in all cases consult Hand Held Products to determine whether any such changes have been made. The information in this publication does not represent a commitment on the part of Hand Held Products.
Table of Contents Chapter 1 - Introduction Design Overview .................................................................................................................................1-1 User Layer.....................................................................................................................................1-1 OEM API Layer ............................................................................................................................1-1 Image Acquisition Layer........
oemGetSetupCode39 .................................................................................................................2-19 oemGetSetupCode49 .................................................................................................................2-20 oemGetSetupCode93 .................................................................................................................2-21 oemGetSetupComposite ...................................................................................
oemSetupCode128 .....................................................................................................................2-49 oemSetupCode16K ....................................................................................................................2-50 oemSetupCode39 .......................................................................................................................2-50 oemSetupCode49 ...................................................................................
iv
1 Introduction This document is an overview of the structure of the IT4X00 Series OEM imaging software provided by Hand Held Products. Detailed information that describes the Hand Held Products OEM Application Programming Interface is provided as a part of the 4X00 Series. Design Overview The Hand Held Products OEM imaging software supports a number of different Hand Held Products imaging engines, while exposing the user to a common programming interface for all supported imagers.
Features of the 4X00 Series The 4X00 Series consists of the following: • The API Definition and Documentation • API Libraries • Sample Code The 4X00 Series functions are defined on a higher level so they can be easily understood and integrated into your applications. • • • • The image/data capture engine is easily integrated. A single API is used for all Hand Held Products engines. Libraries are available for Windows CE 2.x and Windows CE 3.x.
Image Engine API Library Summary The following is a summary of the API functions. The full description of each of function is found on the page noted.
oemGetSetupCodabar Gets the Codabar symbology decoding options 2-16 oemGetSetupCodablock Gets the Codablock symbology decoding options 2-16 oemGetSetupCode11 Gets the Code 11 symbology decoding options 2-17 oemGetSetupCode128 Gets the Code 128 symbology decoding options 2-18 oemGetSetupCode16K Gets the Code 16K symbology decoding options 2-18 oemGetSetupCode32 Gets the Code 32 symbology decoding options 2-19 oemGetSetupCode39 Gets the Code 39 symbology decoding options 2-19 oemGetSetupC
oemSetDecodeMode Sets the decoding mode of the engine 2-45 oemSetLinearRange Sets the size of the window used in the Advanced Linear decoding mode 2-46 oemSetPrintWeight Adjust the print weight or relative blackness that the decoder expects 2-46 oemSetSearchTimeLimit Sets the maximum time limit for the decoders search processing 2-47 oemSetupAztec Set the Aztec Code symbology decoding options 2-47 oemSetupChinaPost Set the Chinese Postal Code symbology decoding options 2-47 oemSetupCodabar
The engine scans until a symbol is decoded, or a timeout is reached - decoded message is returned in raw form 2-68 oemWaitMultipleDecode Reads multiple symbols using a single function call 2-69 oemWaitMultipleDecodeRaw Reads multiple symbols using a single function call - decoded message is returned in raw form 2-70 oemAcquireImage Acquires an image but does not return it. 2-1 oemGetExposureSettings Retrieves image parameters used during image acquisition.
Variable Description Result_t Enumerated integer type that defines API function result values. See Function Result Values on page 3-2. ScanIlluminat_t Enumerated integer type that identifies possible illumination modes used during image acquisition. SetupType_t Enumerated integer type that identifies setup type for configuration functions. TCHAR OS-dependent character variable. 16 bit for Unicode systems, otherwise 8 bits. WORD 16 bit unsigned integer variable.
1-8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide
2 API Function Descriptions The following is an alphabetic listing of each API function with its complete description and a prototype for each function. All API functions return a result code of type Result_t. See Function Result Values on page 3-2 for a table of result code values. oemAcquireImage This function tells the Imager to acquire an image, but does not return the image.
Parameters bEnable If TRUE, the aiming mechanism is turned on; otherwise the aiming mechanism is turned off. oemConnect The application should call this function before any other API functions. Once an application has connected to the engine, all other API functions can be successfully called. The application does not need to re-connect to the engine unless it has called oemDisconnect (page 9).
oemDisableSymbologyAll This function disables all symbologies from decoding, including any unknown symbologies. Result_t oemDisableSymbologyAll ( void ) Return Values RESULT_SUCCESS Parameters None. oemDisconnect This function terminates the connection with the engine. Any resources used by the connection device driver are freed. Result_t oemDisconnect ( void ) Return Values RESULT_SUCCESS Parameters None. oemEnableSymbology This function enables specified symbologies for decoding.
oemGetAPIRevision This function returns an ASCII string containing the API's current revision. Result_t oemGetAPIRevision ( TCHAR *pszRev ) Return Values RESULT_SUCCESS always Parameters pszRev Upon successful return, this null-terminated string is filled in with the revision level of the API. The caller must allocate at least ENGINE_API_RESPONSE_LEN bytes for this string. oemGetDecodeAttemptLimit This function is used to retrieve the current decode attempt maximum time limit.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. PbEnabled Pointer to a BOOL which returns TRUE if centering mode enabled or FALSE if it's not. oemGetDecodeMode This function retrieves the decoding mode of the engine. Result_t oemGetDecodeMode ( SetupType_t SetupType, WORD *pnMode ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.
oemGetErrorMessage This function returns a string containing the description of the error corresponding to the nError parameter. Result_t oemGetErrorMessage ( TCHAR *pszErrorMsg, Result_t nError ) Return Values RESULT_SUCCESS always Parameters pszErrorMsg Upon successful return, this null-terminated string is filled in with text describing the error identified by the nError parameter. The caller must allocate at least ENGINE_API_RESPONSE_LEN bytes for this string.
oemGetImage This function retrieves an image from the engine and stores it in memory pointed to by pImageBuffer.
nExposeAttempts The number of attempts the unit makes to get the image to the correct exposure level. nGap How close the white value of the image must be to the nWhiteValue for the image to be accepted. A value of 0 (zero) can be passed in to cause the unit to use its pre-defined value. For example, if you want to use 10 for the nGap, and the default value for nWhiteValue, then pass in 10 for nGap, and 0 for nWhite. Invert The image is rotated 180° (upside down).
Parameters pnCols Upon successful return, this variable points to the number of column pixels in the Imager. pnRows Upon successful return, this variable points to the number of row pixels in the Imager. pnBits Upon successful return, this variable points to the number of bits per pixel supported by the Imager. oemGetImagerProperties This function returns information about the imager.
oemGetLastImage This function is used to retrieve the last image acquired by the image engine. Result_t oemGetLastImage ( BYTE *pImageBuffer DWORD *pImageSize ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_NOIMAGE Parameters pImageBuffer Pointer to the user supplied buffer to be filled with the image data. The buffer must be at least MAX_IMAGE_SIZE in size. pImageSize Pointer to a DWORD that returns the size of the image.
oemGetLastImageSize This function returns the number of rows, number of columns and size in bytes of the last image returned by one of the other imaging functions: oemAcquireImage, oemGetImage/oemGetImageData or oemImageStreamRead. Result_t oemGetLastImageSize ( WORD *pwCols, WORD *pwRows, DWORD *pdwSize ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pwCols Upon successful return, this variable points to the number of column pixels in the Image.
oemGetLinearRange This function is used to get the size of the window used in the Advanced Linear decoding mode. Result_t oemGetLinearRange ( SetupType_t SetupType, WORD *pnLinearRange ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pnLinearRange Points to a WORD variable where the range value will be placed.
oemGetScanDriverRevision This function returns the revision of the scan driver component that interfaces to the OEM API layer. Result_t oemGetScanDriverRevision( TCHAR *pszRev ) Return Values RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED RESULT_ERR_SUCCESS Parameters pszRev Pointer to string that will contain the revision string. This should be allocated prior to the call and contain 80 characters. oemGetSearchTimeLimit This function is used to retrieve the current search maximum time limit.
oemGetSetupAusPost This function is used to get the Australian Postal Code symbology-specific options. Result_t oemGetSetupAusPost ( SetupType_t SetupType, BOOL *pEnabled ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. oemGetSetupCanPost This function is used to get the Canadian Post symbology-specific options.
oemGetSetupCodabar This function is used to get the Codabar symbology-specific options. Result_t oemGetSetupCodabar ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength BOOL *pbSSXmit, BOOL *pbCheckCharOn, BOOL *pbXmitCheckChar ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded Codablock message the engine should return. Codablock messages smaller than this minimum length are not reported by the engine.
oemGetSetupCode128 This function is used to get the Code 128 symbology-specific options. Result_t oemGetSetupCode128 ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
oemGetSetupCode32 This function is used to get the Code 32 symbology specific options. Result_t oemGetSetupCode32 ( SetupType_t SetupType, BOOL *pEnabled, ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded Code 39 message the engine should return. Code 39 messages smaller than this minimum length are not reported by the engine.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded Code 49 message the engine should return. Code 49 messages smaller than this minimum length are not reported by the engine.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded EANoUCC Composite message the engine should return.
oemGetSetupCouponCode This function is used to get the UPC-A with extended Coupon Code symbology specific options. Result_t oemGetSetupCouponCode ( SetupType_t SetupType, BOOL *pEnabled ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
oemGetSetupDutchPost This function is used to get theKIX (Netherlands) Post symbology-specific options. Result_t oemGetSetupDutchPost ( SetupType_t SetupType, BOOL *pEnabled ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after a successful decode. If TRUE, the engine returns the check character.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after a successful decode. If TRUE, the engine returns the check character.
oemGetSetupImager This function gets the current Imager setup values. Prototype Result_t oemGetSetupImager ( SetupType_t SetupType, ImagerSetup_t *pImagerSetup ) Return Values RESULT_SUCCESS Parameters pImagerSetup Data structure that sets up the Imager. See oemAcquireImage (page 2-1) for details. SetupType This parameter is ignored. oemGetSetupInt25 This function is used to get the Interleaved 2 of 5 symbology-specific options.
oemGetSetupISBT This function is used to get the ISBT 128 symbology-specific options. Result_t oemGetSetupISBT ( SetupType_t SetupType, BOOL *pEnabled ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded Korean Post message the engine should return.
oemGetSetupMesa This function is used to get the Aztec Mesa Code symbology-specific options. Result_t oemGetSetupMesa ( SetupType_t SetupType, BOOL *pUMSEnabled, BOOL *pEMSEnabled, BOOL *p3MSEnabled, BOOL *p1MSEnabled, BOOL *pIMSEnabled, BOOL *p9MSEnabled ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pUMSEnabled Points to a BOOL variable that contains the enabled state of UPCA Mesa.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded MicroPDF417 message the engine should return.
oemGetSetupMx25 This function is used to get the Matrix 2 of 5 symbology specific options. Result_t oemGetSetupMx25 ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. nFont This determines which OCR fonts (if any) are selected for decoding. The following values are used: OCR_DISABLED OCR_A OCR_B OCR_MONEY OCR_MICR (currently unsupported) pszTemplate A null-terminated string that indicates one or more template patterns for the OCR decode.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded PDF417 message the engine should return. PDF417 messages smaller than this minimum length are not reported by the engine.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pMinLength Points to a WORD variable that contains the minimum length decoded Plessey Code message the engine should return.
oemGetSetupPostnet This function is used to get the Postnet symbology-specific options. Result_t oemGetSetupPostnet ( SetupType_t SetupType, BOOL *pEnabled, BOOL *bXmitCheckDigit ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
oemGetSetupRSS This function is used to get the RSS Expanded symbology-specific options. Result_t oemGetSetupRSS ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
oemGetSetupTelepen This function is used to get the Telepen symbology specific options. Result_t oemGetSetupTelepen ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength, BOOL *pOldStyle ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
oemGetSetupTrioptic This function is used to get the Trioptic Code symbology specific options. Result_t oemGetSetupTrioptic ( SetupType_t SetupType, BOOL *pEnabled, ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pEnabled Points to a BOOL variable that contains the enabled state of this symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pbXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check digit as part of the data string after a successful decode. If TRUE, the engine returns the check digit.
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. pE0Enabled Points to a BOOL variable that contains the enabled state of UPC-E0 symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled. pE1Enabled Points to a BOOL variable that contains the enabled state of UPC-E1 symbology upon returning from the function. A TRUE means the symbology is enabled; a FALSE means the symbology is disabled.
oemImageStreamInit This function is used to intialize the image stream interface. The caller is allowed to specifiy the skip (subsample) value. Note: If nSkip is greater than 1, the resulting image will be subsampled by nSkip. Result_t oemImageStreamInit ( WORD nSkip, RECT *imgRect, BOOL bFlip ) Return Values RESULT_SUCCESS RESULT_ERR_DRIVER Parameters nSkip The subsample number. A skip of 1 means all pixels, a skip of 2 means interpolate pixel pairs for every other line.
oemImageStreamStop This function causes the Image Engine to stop continous collecting of images started by oemImageStreamInit() and oemImageStreamStart(). If this function is not called, the imager will continue to acquire images (illumination will stay on) which causes serious drain battery power. Result_t oemImageStreamStop () Return Values RESULT_SUCCESS Parameters None. oemLeaveLightsOn This function configures the illumination LEDs to always be on, or in normal mode during scanning.
This function allows the application to fully power down the imager for additional power control. This gives additional power control to shutdown/resume (normally the only time the sensor fully powers off), but should be balanced since there are time penalties associated with powering back up. Result_t oemPowerOffImager( void ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED Parameters None. oemSetDecodeAttemptLimit This function is used to set the decode attempt maximum time limit.
oemSetDecodeMode This function sets the decoding mode of the engine. Result_t oemSetDecodeMode ( SetupType_t SetupType, WORD nMode ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.
oemSetLinearRange This function sets the size of the window used in the Advanced Linear decoding mode. Result_t oemSetLinearRange ( SetupType_t SetupType, WORD nLinearRange ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. nLinearRange Points to a WORD variable that contains the desired Range Value. 15 lines are searched for a linear bar code.
oemSetSearchTimeLimit This function is used to set the maximum time limit for the decoders search processing. The limit, specified in milliseconds, is the maximum amount of time the search process may use to look for potential labels in the current image. Result_t oemSetSearchTimeLimit ( SetupType_t SetupType, WORD nLimit ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings.
Parameters nMinLength The minimum length decoded China Post message the engine should return. China Post messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 4. nMaxLength The maximum length decoded China Post message the engine should return. China Post messages larger than this maximum length are reported by the engine. The maximum allowable value (as well as the default) is 80.
Parameters nMinLength The minimum length decoded Codablock message the engine should return. Codablock messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 0. nMaxLength The maximum length decoded Codablock message the engine should return. Codablock messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 2048.
oemSetupCode16K This function is used to set the Code 16K symbology-specific options. Result_t oemSetupCode16K ( WORD nMinLength, WORD nMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Code 16K message the engine should return. Code 16K messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 1.
Parameters bSSXmit Points to a BOOL variable that determines if the start and stop characters are returned in the data string after a successful Code 39 decode. If bSSXmit is TRUE, the start and stop characters are included. If FALSE, they are not included. The default value is FALSE. bCheckCharOn Points to a BOOL variable that determines if the engine will read Code 39 bar codes with or without check characters. If TRUE, the engine only decodes Code 39 codes with a check character.
oemSetupCode93 This function is used to set the Code 93 symbology-specific options. Result_t oemSetupCode93 ( WORD nMinLength, WORD nMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Code 93 message the engine should return. Code 93 messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 0. nMaxLength The maximum length decoded Code 93 message the engine should return.
Parameters nMinLength The minimum length decoded EANoUCC Composite message the engine should return. EANoUCC Composite messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 1. nMaxLength The maximum length decoded EANoUCC Composite message the engine should return. EANoUCC Composite messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 300.
Parameters bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after a successful decode. If TRUE, the engine returns the check character. If FALSE, the check character is not returned. The default value is FALSE. bAddenda2Digit Points to a BOOL variable that determines if the engine will look for a 2 digit addenda at the end of the EAN bar code.
oemSetupIATA25 This function is used to set the Straight 2 of 5 IATA symbology-specific options. Result_t oemSetupIATA25 ( WORD nMinLength, WORD nMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded IATA 2 of 5 message the engine should return. IATA 2 of 5 messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 4.
oemSetupKoreanPost This function is used to set the Korean Post symbology-specific options. Result_t oemSetupKoreanPost ( WORD nMinLength, WORD nMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Korean Post message the engine should return. Korean Post messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 4.
oemSetupMesa This function is used to set the Aztec Mesa Code symbology-specific options. Note: The minimum and maximum parameters are set using oemSetupAztec (page 2-47). Result_t oemSetupMesa ( BOOL *pUMSEnabled, BOOL *pEMSEnabled, BOOL *p3MSEnabled, BOOL *p1MSEnabled, BOOL *pIMSEnabled, BOOL *p9MSEnabled, ) Return Values RESULT_SUCCESS Parameters pUMSEnabled Points to a BOOL variable that contains the enabled state of UPCA Mesa. TRUE = Enabled, FALSE = Disabled.
oemSetupMSI This function is used to set the MSI symbology-specific options. Result_t oemSetupMSI ( WORD nMinLength, WORD nMaxLength, BOOL bXmitCheckChar ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded MSI message the engine should return. MSI messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 4. nMaxLength The maximum length decoded MSI message the engine should return.
oemSetupOCR This function is used to set the Optical Character Recognition (OCR) decoding options. OCR character recognition is less secure than reading bar codes. Misreads may occur if a check character is not used. Result_t oemSetupOCR ( OCRMode_t nFont, TCHAR *pszTemplate, TCHAR *pszGroupG, TCHAR *pszGroupH, TCHAR *pszCheckChar OCRDirection_t nDirection ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nFont This determines which OCR fonts (if any) are selected for decoding.
oemSetupPDF417 This function is used to set the PDF417 symbology-specific options. Result_t oemSetupPDF417( WORD nMinLength, WORD nMaxLength ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded PDF417 message the engine should return. PDF417 messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 1. nMaxLength The maximum length decoded PDF417 message the engine should return.
oemSetupPosiCode This function is used to set the PosiCode symbology-specific options. Result_t oemSetupPosiCode ( WORD nMinLength, WORD nMaxLength, WORD nLimited ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded PosiCode message the engine should return. PosiCode messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 4.
Parameters nMinLength The minimum length decoded QR Code message the engine should return. QR Code messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 1. nMaxLength The maximum length decoded QR Code message the engine should return. QR Code messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 3500.
oemSetupTelepen This function is used to set the Telepen symbology-specific options. Result_t oemSetupTelepen ( WORD nMinLength, WORD nMaxLength, BOOL bOldStyle ) Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Telepen message the engine should return. Telepen messages smaller than this minimum length are not reported by the engine. The minimum allowable value (as well as the default) is 1.
Parameters bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check digit as part of the data string after a successful decode. If TRUE, the engine returns the check digit. If FALSE, the check digit is not returned. The default value is FALSE. bXmitNumSys Points to a BOOL variable that determines if the engine will return the numeric system digit of the UPC label. If TRUE, the engine returns the number system digit. If FALSE, the number system digit is not returned.
Parameters bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check digit as part of the data string after a successful decode. If TRUE, the engine returns the check digit. If FALSE, the check digit is not returned. The default value is FALSE. bXmitNumSys Points to a BOOL variable that determines if the engine will return the numeric system digit of the UPC label. If TRUE, the engine returns the number system digit. If FALSE, the number system digit is not returned.
This function uses the dimensions of the bar code as its coordinate system. Thus, all parameters describing the image size and position are in units called Intelligent Bar Code Units. An Intelligent Bar Code Unit is equivalent to the narrow element width of the bar code. Once the transfer has started, use oemGetImageData (page 12) to retrieve the image.
Parameters pImageDesc Pointer to a data structure describing the image to to be retrieved. typedef struct { int AspectRatio; int OffsetX; int OfsetY; unsigned int width; unsigned int height; int resolution; FileFormat_t format; int reserved; } IntellImgDesc _t; Aspect Ratio: OffsetX: OffsetY: width: height: resolution: format: Ratio of the bar code height (linear bar codes) or row height (2D bar codes) to the narrow element width.
Parameters dwTimeout Time in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero. pchMessage Upon successful return, this variable points to the decoded message. The caller should allocate enough memory for this buffer to hold the largest possible decode message. See oemGetMaxMessageChars (page 2-12). pchCodeID Upon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. See Symbology Identifiers (page 3-1).
Parameters dwTimeout Time in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero. pchMessage Upon successful return, this variable points to the decoded message. The caller should allocate enough memory for this buffer to hold the largest possible decode message. See oemGetMaxMessageChars (page 2-12). pchCodeID Upon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. See Symbology Identifiers (page 3-1).
Parameters dwTimeout Maximum amount of time in milliseconds that the decoder may use to attempt to find and decode symbols. fpMultiReadCallBack Pointer to a callback function that takes a DecodeMsg_t variable as a parameter and returns a BOOL. Upon a successful decode, the decoder calls this function using the DecodeMsg_t variable to return the decode data. The return parameter from this function dictates if the decoder continues to look for additional symbols.
3 Symbology Identifiers Symbology Identifiers The following symbology identifiers are defined in the Oemdecodece.h header file. Note: AIMID output is a pointer to the second character of the AIM ID string in the following chart. SymModifier is a pointer to the modifier (m) character for Possible AIM ID Modifiers in the following chart. Please consult the appropriate symbology specification for discussion of AIM symbology IDs and modifiers.
Function Result Values The following function result values are a sample of the values defined in the Oemdecodece.h header file. RESULT_SUCCESS The API function succeeded. RESULT_ERR_BADREGION An image was requested using an invalid image region. RESULT_ERR_DRIVER The API function caused an error in the engine driver, or driver not available. RESULT_ERR_ENGINEBUSY The API function failed because the engine was busy (imaging). RESULT_ERR_FILEINVALID The file was not a valid firmware upgrade file.
4 Customer Support Technical Assistance If you need assistance using the SDK, please call your Distributor or the nearest Hand Held Products technical support office: North America/Canada: Telephone: (800) 782-4263, option 4 (8 a.m. to 6 p.m. EST) Fax: (315) 685-4960 E-mail: natechsupport@handheld.com America Latina: Teléfono: E-mail: (704) 998-3998, opción 8 latechsupport@handheld.com Brazil Telephone: +55 (21) 2176-0250 Fax: +55 (21) 2176-0249 E-mail: suporte@handheld.
4-2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK)
Hand Held Products, Inc. 700 Visions Drive P.O.
