Hand Held Products 4X00 manual

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 do cument without prior notice, and the reader should in al l cases consult Hand Held Products to determine whether any such changes have been made . The information in [...]

i Chapter 1 - Introduction Design Overview ........ ......................................................................................................................... 1-1 User Layer ..................................................................................................................... ................ 1-1 OEM API Layer ... ....[...]

ii oemGetSetupCode39 ............................................................................................................. .... 2-19 oemGetSetupCode49 ............................................................................................................. .... 2-20 oemGetSetupCode93 .....................................................[...]

iii oemSetupCode128 ............................................................................................................... ...... 2-49 oemSetupCode16K ............................................................................................................... ..... 2-50 oemSetupCode39 ....................................................[...]

iv[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 1 1 Introduc tion This document is an overview of the stru cture of the IT4X00 Series OEM imaging soft ware provided by Hand Held Products. Detailed information that descri bes the Hand Held Products OEM Application Programming Interface is provided as a part of the 4X00 Ser[...]

1 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 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 hi gher level so they can be ea sily understood and integrat ed into your applicatio[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 3 Image Engine API Library Summary The following is a summary of the API functions. The full de scription of each of function is found on the page noted. Core Function Summary Description Page oemAimerOn Turn on/off the engine's aiming LEDs 2-1 oemConnect Initialize con[...]

1 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupCodabar Gets the Codabar sym bology decoding options 2-16 oemGetSetupCodablock Gets the Codablock sy mbology decoding options 2-16 oemGetSetupCode11 Gets the Code 11 symbology decoding options 2-17 oemGetSetupCode128 Gets the Code 128 symb ology decoding options[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 5 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 rela tive blackness that the decoder expects 2-46 oemSetSearchTimeLimit Sets[...]

1 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Data T ype Definitions Throughout this document the foll owing variable types are used. These data ty pes are defined in th e Oemdecodece.h header file. oemWaitForDecodeRaw The engine scans until a symbol is decoded, or a timeout is reached - decoded message is returned in[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 7 Result_t Enumerated integer type that define s 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 id[...]

1 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 1 2 API F unction D escriptions The following is an alphabetic listing of each API function with its complete descript ion and a prototype for each function. A ll API functions return a result co de of type Result_t. See Function Result Values on page 3-2 for a table of resu[...]

2 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s bEnable If TRUE, the aiming mechanism is turned on; ot herwise the aiming mechanism is turned off. oemConnect The application should call this function before any other API functions. Once an applic ation has connected to the engine, all other API functi[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 3 oemDisableSymbologyAll This function disables all symbologies from decoding, including an y unknown symbologies. Result_t oemDisableSymbologyAll ( void ) Return V alues RESULT_SUCCESS Pa r a m e t e r s None. oemDisconnect This function terminates the connection wi th the [...]

2 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetAPIRevision This function returns an ASCII string containing the API's current revision. Result_t oemGetAPIRevision ( TCHAR *pszRev ) Return V alues RESULT_SUCCESS always Pa r a m e t e r s pszRev Upon successful return, this null-terminate d string is filled in[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 5 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. PbEnabled Pointer to a BOOL which returns TRUE if ce ntering mode enabled or FALSE if it's not. oemGetDecodeMode This function retrieves the decoding mode[...]

2 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetErrorMessage This function returns a string contai ning the description of the error corresponding to the nError parameter. Result_t oemGetErrorMessage ( TCHAR *pszErrorMsg, Result_t nError ) Return V alues RESULT_SUCCESS always Pa r a m e t e r s pszErrorMsg Upon su[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 7 oemGetImage This function retrieves an image from the engine and stores it in memo ry pointed to by pImageBuffer. Result_t oemGetImage ( BYTE *pImageBuffer, DWORD *pdwSize, WORD nTop, WORD nLeft, WORD nRight, WORD nBottom, WORD nSkip, WORD nBits, FileFormat_t nFormat, WORD[...]

2 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide nExposeAttempts The number of attempts the unit makes to ge t the image to the co rrect exposure level. nGap How close the white value of the image mu st be to the nWhiteValue for the image to be accepted. A value of 0 (zero) can be passed in to cause the unit to us e its [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 9 Pa r a m e t e r s 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 variabl e points to the n[...]

2 - 10 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 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 use[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 11 oemGetLastImageSize This function returns the number of rows, number of columns and size in bytes of t he last image returned by one of the other imaging functions: oemAcquireImage, oemGe tImage/oemGetImageData or oemImageStreamRead. Result_t oemGetLastImageSize ( WORD *p[...]

2 - 12 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetLinearRange This function is used to get the size of the window used in th e Advanced Linear decoding mode. Result_t oemGetLinearRange ( SetupType_t SetupType, WORD *pnLinearRange ) Return V alues RESULT_SUCCESS RESULT_ERR_UNSUPPORTED Pa r a m e t e r s SetupType SE[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 13 oemGetScanDriverRevision This function returns the revision of the scan driv er component that interfaces to the OEM API layer. Result_t oemGetScanDriverRevision( TCHAR *pszRev ) Return V alues RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED RESULT_ERR_SUCCESS Pa r a m e t e [...]

2 - 14 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupAusPost This function is used to get the Australian Postal Code symbology-specific options. Result_t oemGetSetupAusPost ( SetupType_t SetupType, BOOL *pEnabled ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 15 Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s 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 th[...]

2 - 16 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupCodabar This function is used to get th e Codabar symbology-specific options. Result_t oemGetSetupCodabar ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength BOOL *pbSSXmit, BOOL *pbCheckCharOn, BOOL *pbXmitCheckChar ) Return V alues RES[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 17 Pa r a m e t e r s 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; [...]

2 - 18 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 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 V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupTy[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 19 oemGetSetupCode32 This function is used to get the Code 32 symbology specific options. Result_t oemGetSetupCode32 ( SetupType_t SetupType, BOOL *pEnabled, ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current sett[...]

2 - 20 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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; [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 21 Pa r a m e t e r s 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; [...]

2 - 22 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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; [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 23 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 V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETU[...]

2 - 24 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupDutchPost This function is used to get theKIX (N etherlands) Post symbology-specific options. Result_t oemGetSetupDutchPost ( SetupType_t SetupType, BOOL *pEnabled ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURR[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 25 Pa r a m e t e r s 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; [...]

2 - 26 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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; [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 27 oemGetSetupImager This function gets the cu rrent Imager setup values. Prototype Result_t oemGetSetupImager ( SetupType_t SetupType, ImagerSetup_t *pImagerSetup ) Return V alues RESULT_SUCCESS Pa r a m e t e r s pImagerSetup Data structure that sets up the Imager. See oem[...]

2 - 28 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupISBT This function is used to get the ISBT 128 symbology-specific options. Result_t oemGetSetupISBT ( SetupType_t SetupType, BOOL *pEnabled ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 29 Pa r a m e t e r s 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; [...]

2 - 30 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupMesa This function is used to get the Azte c Mesa Code symbology-specific options. Result_t oemGetSetupMesa ( SetupType_t SetupType, BOOL *pUMSEnabled, BOOL *pEMSEnabled, BOOL *p3MSEnabled, BOOL *p1MSEnabled, BOOL *pIMSEnabled, BOOL *p9MSEnabled ) Return V alue[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 31 Pa r a m e t e r s 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; [...]

2 - 32 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupMx25 This function is used to get the Matr ix 2 of 5 symbology specific options. Result_t oemGetSetupMx25 ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupTy[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 33 Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. nFont This determines which OCR fonts (if any) are select ed for decoding. The following values are used: OCR_DISABLED OCR_A OCR_B OCR_MONEY OCR_MICR (current[...]

2 - 34 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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; [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 35 Pa r a m e t e r s 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; [...]

2 - 36 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemGetSetupPostnet This function is used to get th e Postnet symbology-specific options. Result_t oemGetSetupPostnet ( SetupType_t SetupType, BOOL *pEnabled, BOOL *bXmitCheckDigit ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 37 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 V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType S[...]

2 - 38 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 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 V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 39 oemGetSetupTrioptic This function is used to get the Tri optic Code symbology specific options. Result_t oemGetSetupTrioptic ( SetupType_t SetupType, BOOL *pEnabled, ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for c[...]

2 - 40 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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; [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 41 Pa r a m e t e r s 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 enabl[...]

2 - 42 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemImageStreamInit This function is used to intialize the imag e stream interface. The caller is allowed to specifiy the skip (subsample) value. Note: If nSkip is greater than 1, the resultin g image will be subsampled by nSkip. Result_t oemImageStreamInit ( WORD nSkip, R[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 43 oemImageStreamStop This function causes the Image Engine to stop continous collecting of image s started by oemImageStreamInit() and oemImageStreamStart(). If this function is not called, the imager will continue to ac quire images (illumination will stay on) which causes[...]

2 - 44 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide This function allows the applicat ion to fully power down the imag er 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 associate[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 45 oemSetDecodeMode This function sets the de coding mode of the engine. Result_t oemSetDecodeMode ( SetupType_t SetupType, WORD nMode ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED Pa r a m e t e r s SetupType SETUP_TYPE_CURRENT for current sett[...]

2 - 46 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 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 V alues RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_UNSUPPORTED Pa r a m e t e r s Setu[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 47 oemSetSearchTimeLimit This function is used to set the maximum time limit for the decoders se arch processing. The limit, specified in milliseconds, is the maximum amount of time the search process may use to look for poten tial labels in the current image. Result_t oemSe[...]

2 - 48 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s nMinLength The minimum length decoded Chi na Post message the engine should return. China Post messages smaller than this minimum length are not reported by th e engine. The minimum allowable valu e (as well as the default) is 4. nMaxLength The maximum [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 49 Pa r a m e t e r s nMinLength The minimum length decoded Codablock me ssage the engine should return. Coda block messages smaller than this minimum length are not reported by th e engine. The minimum allowable valu e (as well as the default) is 0. nMaxLength The maximum l[...]

2 - 50 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupCode16K This function is used to set the Code 16K symbology-specific options. Result_t oemSetupCode16K ( WORD nMinLength, WORD nMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded Code 16K message[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 51 Pa r a m e t e r s bSSXmit Points to a BOOL variable that determines if the start a nd 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 d[...]

2 - 52 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupCode93 This function is used to set the Code 93 symbology-specific options. Result_t oemSetupCode93 ( WORD nMinLength, WORD nMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded Code 93 message the[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 53 Pa r a m e t e r s 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. T he minimum allowable value (as well as the default) is 1. nMaxLength [...]

2 - 54 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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 re turns the check character. If FALSE, the check character is not returned.[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 55 oemSetupIATA25 This function is used to set the Straight 2 of 5 IATA symbology-specific options. Result_t oemSetupIATA25 ( WORD nMinLength, WORD nMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded IATA 2[...]

2 - 56 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupKoreanPost This function is used to set the Ko rean Post symbology-specific options. Result_t oemSetupKoreanPost ( WORD nMinLength, WORD nMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded Korean[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 57 oemSetupMesa This function is used to set the Azte c Mesa Code symbology-specific options. Note: The minimum and maximu m parameters are set using oemSetupAztec (page 2-47). Result_t oemSetupMesa ( BOOL *pUMSEnabled, BOOL *pEMSEnabled, BOOL *p3MSEnabled, BOOL *p1MSEnabled[...]

2 - 58 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupMSI This function is used to set th e MSI symbology-specific options. Result_t oemSetupMSI ( WORD nMinLength, WORD nMaxLength, BOOL bXmitCheckChar ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded MSI mes[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 59 oemSetupOCR This function is used to set the Optical Character Recognition (OCR) decoding options. OCR char acter recognition is less secur e than reading bar codes. Misreads may oc cur if a check character is not used. Result_t oemSetupOCR ( OCRMode_t nFont, TCHAR *pszTe[...]

2 - 60 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupPDF417 This function is used to set th e PDF417 symbology-specific options. Result_t oemSetupPDF417( WORD nMinLength, WORD nMaxLength ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded PDF417 message the e[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 61 oemSetupPosiCode This function is used to set the PosiCode symbology-specific options. Result_t oemSetupPosiCode ( WORD nMinLength, WORD nMaxLength, WORD nLimited ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded[...]

2 - 62 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s nMinLength The minimum length decoded QR Code message the engine should return. QR Code me ssages smaller than this minimum length are not reported by th e engine. The minimum allowable valu e (as well as the default) is 1. nMaxLength The maximum length[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 63 oemSetupTelepen This function is used to set th e Telepen symbology-specific options. Result_t oemSetupTelepen ( WORD nMinLength, WORD nMaxLength, BOOL bOldStyle ) Return V alues RESULT_SUCCESS RESULT_ERR_PARAMETER Pa r a m e t e r s nMinLength The minimum length decoded [...]

2 - 64 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check di git as part of the data string after a successful decode. If TRUE, the engine re turns the check digit. If FA LSE, the check digit is not returned. The defa[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 65 Pa r a m e t e r s bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the check di git as part of the data string after a successful decode. If TRUE, the engine re turns the check digit. If FA LSE, the check digit is not returned. The defa[...]

2 - 66 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide This function uses the dimensions of the bar code as its coordinate system. Thus, all parameters describin g the image size and position are in units called Intelligent Ba r Code Units. An Intelligent Bar Code Unit is equivalent to the narrow element widt h of the bar cod[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 67 Pa r a m e t e r s pImageDesc Pointer to a data structure describ ing 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; A[...]

2 - 68 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s 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 po ints to the decoded message. The ca ller should allocate enough memory for this[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 69 Pa r a m e t e r s 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 po ints to the decoded message. The ca ller should allocate enough memory for this[...]

2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Pa r a m e t e r s dwTimeout Maximum amount of time in millisec onds 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 pa rameter and returns a BOOL. Upon a successful [...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 3 - 1 3 S ymbology Identifiers Symbology Identifiers The following symbology identifiers are def ined in the Oemdecodece.h header file. Note: AIMID output is a pointer to the second character of the AIM ID string in the fo llowing chart. SymModifier is a pointer t o the modifier[...]

3 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Function Result V alues The following function result values are a sample of the values defined in th e Oemdecodece.h header file. RESULT_SUCCESS The API function succeeded. RESULT_ERR_BADREGION An image was reques ted using an invalid image region. RESULT_ERR_DRIVER The A[...]

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) 4 - 1 4 Customer Suppor t T echnical Assist ance If you need assistance using the SDK, please call your Distributo r or the nearest Hand Held Pr oducts 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: natechs[...]

4 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK)[...]

[...]

™ Hand Held Products, Inc. 700 Visions Drive P.O. Box 208 Skaneateles Falls, NY 13153-0208 4X00SDK-UG Rev A 6/05 Note: This document replaces the OEMAPI-UG Rev C[...]