1. Manuals
  2. Brands
  3. Hand Held Products Manuals
  4. Barcode Reader
  5. 4X00
  6. Software manual

Hand Held Products 4X00 Software Manual

Imageteam 4x00 series software development kit (sdk)
Hide thumbs Also See for 4X00:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
™
IMAGETEAM
4X00 Series
For Adaptus Imaging Technology Imagers:
IT4000, IT4100, and IT4300
Software Development Kit (SDK)
User's Guide

Advertisement

Table of Contents
loading

Related Manuals for Hand Held Products 4X00

Summary of Contents for Hand Held Products 4X00

  • Page 1 ™ IMAGETEAM 4X00 Series For Adaptus Imaging Technology Imagers: IT4000, IT4100, and IT4300 Software Development Kit (SDK) User’s Guide...
  • Page 2 Hand Held Products. Hand Held Products shall not be liable for technical or editorial errors or omissions contained herein; nor for incidental or consequential damages resulting from the furnishing, performance, or use of this material.

  • Page 3: Table Of Contents

    User Layer...1-1 OEM API Layer ...1-1 Image Acquisition Layer...1-1 Hardware Interface Layer ...1-1 Features of the 4X00 Series...1-2 Target Operating Systems for the 4X00 Series...1-2 Data Type Definitions ...1-6 Chapter 2 - API Function Descriptions oemAcquireImage ...2-1 oemAimerOn ...2-1 oemConnect ...2-2 oemDefaultSymbology ...2-2...
  • Page 4 oemGetSetupCode39 ...2-19 oemGetSetupCode49 ...2-20 oemGetSetupCode93 ...2-21 oemGetSetupComposite ...2-21 oemGetSetupCompositeEx ...2-22 oemGetSetupCouponCode ...2-23 oemGetSetupDataMatrix ...2-23 oemGetSetupDutchPost ...2-24 oemGetSetupEAN8 ...2-24 oemGetSetupEAN13 ...2-25 oemGetSetupIATA25 ...2-26 oemGetSetupImager ...2-27 oemGetSetupInt25 ...2-27 oemGetSetupISBT ...2-28 oemGetSetupJapost ...2-28 oemGetSetupKoreanPost ...2-28 oemGetSetupMaxicode ...2-29 oemGetSetupMesa ...2-30 oemGetSetupMicroPDF ...2-30 oemGetSetupMSI ...2-31 oemGetSetupMx25 ...2-32 oemGetSetupOCR ...2-32 oemGetSetupPDF417 ...2-33...
  • Page 5 oemSetupCode128 ...2-49 oemSetupCode16K ...2-50 oemSetupCode39 ...2-50 oemSetupCode49 ...2-51 oemSetupCode93 ...2-52 oemSetupComposite ...2-52 oemSetupCompositeEx ...2-52 oemSetupDataMatrix ...2-53 oemSetupEAN8 ...2-53 oemSetupEAN13 ...2-54 oemSetupIATA25 ...2-55 oemSetupInt25 ...2-55 oemSetupKoreanPost ...2-56 oemSetupMaxicode ...2-56 oemSetupMesa ...2-57 oemSetupMicroPDF ...2-57 oemSetupMSI ...2-58 oemSetupMx25 ...2-58 oemSetupOCR ...2-59 oemSetupPDF417 ...2-60 oemSetupPlanet ...2-60 oemSetupPlessey ...2-60 oemSetupPosiCode ...2-61...

  • Page 7: Design Overview

    OEM API Software functionality is provided in the form of a Windows Dynamic Link Library. For non- Windows CE applications, the form of the OEM API is to be determined. Full explanation of the 4X00 Series is provided later in this document.

  • Page 8: Features Of The 4X00 Series

    • 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.
  • Page 9 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Summary Description Turn on/off the engine's aiming LEDs Initialize connection with engine device Close the connection to the engine device Retrieve the API library's software revision information...
  • Page 10 Determines if decoding of inverted symbols is enabled Turns the engine's illumination LEDs on and off. Sets the decode attempt maximum time limit. Enables/Setup decode centering mode. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2-16 2-16 2-17 2-18...
  • Page 11 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Sets the decoding mode of the engine Sets the size of the window used in the Advanced Linear decoding mode Adjust the print weight or relative blackness that the decoder...

  • Page 12: Data Type Definitions

    Enumerated integer type used to select the exposure mode used during image acquisition. ExposureMode_t The mode options are: fixed, on chip, and Hand Held Products exposure mode. Typedef structure used to hold all possible exposure setting parameters used during image ExposureSettings_t acquisition.
  • Page 13 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. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide on page 3-2. Function Result 1 - 7...
  • Page 14 1 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 15: Oemacquireimage

    This function turns the engine's aiming mechanism on or off. Result_t oemAimerOn ( BOOL bEnable Return Values RESULT_SUCCESS RESULT_ERR_DRIVER RESULT_ERR_NORESPONSE IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Function Result Values on page 3-2 for a table of result code values. 2 - 1...

  • Page 16: Oemconnect

    Points to an array of symbologies you want to disable. For example, if a value is set to 1 (i.e., pSymbology [SYM_AZTEC]=1), then Aztec decoding is disabled. Note: The array must be of size MAX_SYMBOLOGIES (Defined in Oemdecodece.h). You must initialize the entire array before calling this function. 2 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 17: Oemdisablesymbologyall

    Note: The array must be of size MAX_SYMBOLOGIES (Defined in Oemdecodece.h). You must initialize the entire array before calling this function. oemEnableSymbologyAll This function enables all symbologies for decoding, including any unknown symbologies. Result_t oemEnableSymbologyAll ( void Return Values RESULT_SUCCESS Parameters None. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 3...

  • Page 18: Oemgetapirevision

    Note: This function allows the engine to discriminate symbols that are located physically close to each other so only one symbol is captured during decode. Only the symbol intersecting the intersection rectangle is returned. Result_t oemGetDecodeCenteringWindow ( SetupType_t SetupType, BOOL *pbEnabled, RECT *pIntersectRect Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 19: Oemgetdecodemode

    This function the time in milliseconds that it took to decode the barcode data returned by oemWaitForDecode(). Result_t oemGetDecodeTime ( DWORD *pdwTime, Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pdwTime Points to an unsinged 32 bit integer into which the last time to decode is returned. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 5...

  • Page 20: Oemgeterrormessage

    A pointer to an exposure settings structure that has been initialized to zero. Upon return the structure will contain the current exposure parameters used during image acquisition. 2 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 21: Oemgetimage

    The grayscale data stored in the pImageBuffer is stored 8 bit per pixel starting with the upper left pixel and proceeding sequentially left to right and top to bottom. nWhiteValue The target white value when performing auto exposure control. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 7...

  • Page 22: Oemgetimagedata

    Returns the number of bytes of image data read. oemGetImagerInfo This function returns information about imaging capability of the connected device. Result_t oemGetImagerInfo ( WORD *pnCols, WORD *pnRows, WORD *pnBits Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 23: Oemgetimagerproperties

    This value represents the X coordinate for the center of the aimer pattern. dwAimerYoffset: This value represents the Y coordinate for the center of the aimer pattern. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 9...

  • Page 24: Oemgetlastimage

    Pointer to an ImageAttributes_t structure that has been initialized to zeros. Upon successful return the structure will contain the specific values for the returned image. Please see the engnapi.h header file for details of the ImageAttributes_t structure. 2 - 10 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 25: Oemgetlastimagesize

    LEDs will be in normal operational mode and will be flashed on and off during scanning. If TRUE, the illumination LEDs are always on during scanning and will not flash. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 11...

  • Page 26: Oemgetlinearrange

    Upon successful return, this variable points to the print weight (relative blackness) that the decoder expects to see when attempting to decode symbols or OCR text from an image. 2 - 12 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 27: Oemgetscandriverrevision

    Points to an array of symbologies with a size of MAX_SYMBOLOGIES. This array should be declared and cleared. Upon return, this array will contain the enable/disable status of each symbology. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 13...

  • Page 28: Oemgetsetupauspost

    Aztec or Aztec Mesa Codes messages larger than this maximum length are reported by the engine. The default value is 3750. oemGetSetupBPO This function is used to get the British Post symbology-specific options. Result_t oemGetSetupBPO ( SetupType_t SetupType, BOOL *pEnabled 2 - 14 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 29: Oemgetsetupcanpost

    Points to a WORD variable that contains the maximum length decoded China Post message the engine should return. China Post messages larger than this maximum length are not reported by the engine. The default value is 80. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 15...

  • Page 30: Oemgetsetupcodabar

    The default value is FALSE. oemGetSetupCodablock This function is used to get the Codablock F symbology-specific options. Result_t oemGetSetupCodablock ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 16 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 31: Oemgetsetupcode11

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

  • Page 32: Oemgetsetupcode128

    Points to a WORD variable that contains the maximum length decoded Code16K message the engine should return. Code 16K messages larger than this maximum length are not reported by the engine. The default value is 160. 2 - 18 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 33: Oemgetsetupcode32

    This function is used to get the Code 39 symbology-specific options. Result_t oemGetSetupCode39 ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength, BOOL *pbSSXmit, BOOL *pbFullAscii, BOOL *pbAppend, BOOL *pbCheckCharOn, BOOL *bXmitCheckChar Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 19...

  • Page 34: Oemgetsetupcode49

    The default value is FALSE. oemGetSetupCode49 This function is used to get the Code 49 symbology-specific options. Result_t oemGetSetupCode49 ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 20 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 35: Oemgetsetupcode93

    Code 93 messages larger than this maximum length are reported by the engine. The default value is 80. oemGetSetupComposite This function is used to get the EANoUCC Composite symbology-specific options. Result_t oemGetSetupComposite ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 21...

  • Page 36: Oemgetsetupcompositeex

    EANoUCC Composite messages larger than this maximum length are reported by the engine. The default value is 2750. pbCompositeOnUpcEan Points to a BOOL variable that contains the enabled state of EANoUCC Composite code associated with EAN and UPC codes. 2 - 22 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 37: Oemgetsetupcouponcode

    Points to a WORD variable that contains the maximum length decoded Data Matrix message the engine should return. Data Matrix messages larger than this maximum length are reported by the engine. The default value is 1500. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 23...

  • Page 38: Oemgetsetupdutchpost

    This function is used to get the EAN-8 symbology-specific options. Result_t oemGetSetupEAN8 ( SetupType_t SetupType, BOOL *pEnabled, BOOL *bXmitCheckChar, BOOL *pAddendaReq, BOOL *bAddendaSeparator, BOOL *bAddenda2Digit, BOOL *bAddenda5Digit Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 24 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 39: Oemgetsetupean13

    This function is used to get the EAN-13 symbology-specific options. Result_t oemGetSetupEAN8 ( SetupType_t SetupType, BOOL *pEnabled, BOOL *bXmitCheckChar, BOOL *pAddendaReq, BOOL *bAddendaSeparator, BOOL *bAddenda2Digit, BOOL *bAddenda5Digit Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 25...

  • Page 40: Oemgetsetupiata25

    Points to a WORD variable that contains the maximum length decoded IATA 2 of 5 message the engine should return. IATA 2 of 5 messages larger than this maximum length are reported by the engine. The default value is 80. 2 - 26 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 41: Oemgetsetupimager

    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. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemAcquireImage (page 2-1) for details.

  • Page 42: Oemgetsetupisbt

    This function is used to get the Korean Post symbology specific options. Result_t oemGetSetupKoreanPost ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 28 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 43: Oemgetsetupmaxicode

    Points to a BOOL variable that determines if the engine will return only the Structured Carrier Message portion of the decoded message. When TRUE, the engine only returns the Structured Carrier Message data. When FALSE, the engine returns the entire message. The default value is FALSE. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 29...

  • Page 44: Oemgetsetupmesa

    Points to a BOOL variable that contains the enabled state of Code 93 Mesa. oemGetSetupMicroPDF This function is used to get the MicroPDF417 symbology-specific options. Result_t oemGetSetupMicroPDF ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 30 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 45: Oemgetsetupmsi

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

  • Page 46: Oemgetsetupmx25

    This function is used to get the Optical Character Recognition (OCR) decoding options. Result_t oemGetSetupOCR ( SetupType_t SetupType, OCRMode_t *nFont, TCHAR *pszTemplate, TCHAR *pszGroupG, TCHAR *pszGroupH, TCHAR *pszCheckChar, OCRDirection_t *nDirection Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 32 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 47: Oemgetsetuppdf417

    This function is used to get the PDF417 symbology-specific options. Result_t oemGetSetupPDF417( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 33...

  • Page 48: Oemgetsetupplanet

    This function is used to get the Plessey Code symbology specific options. Result_t oemGetSetupPlessey ( SetupType_t SetupType, BOOL *pEnabled, WORD *pMinLength, WORD *pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 34 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 49: Oemgetsetupposicode

    1 indicates Posicode Limited A is enabled , and a value of 2 indicates Posicode Limited B decoding is enabled. A value of 0 indicates that decoding of both Limited A and Limited B is disabled. The default value is 0. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 35...

  • Page 50: Oemgetsetuppostnet

    Points to a WORD variable that contains the maximum length decoded QR Code message the engine should return. QR Code messages larger than this maximum length are reported by the engine. The default value is 3500. 2 - 36 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 51: Oemgetsetuprss

    Points to a WORD variable that contains the maximum length decoded Straight 2 of 5 message the engine should return. Straight 2 of 5 messages larger than this maximum length are not reported by the engine. The default value is IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 37...

  • Page 52: Oemgetsetuptelepen

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

  • Page 53: Oemgetsetuptrioptic

    This function is used to get the UPC-A symbology-specific options. Result_t oemGetSetupUPCA ( SetupType_t SetupType, BOOL *pEnabled, BOOL *pbXmitCheckChar, BOOL *pbAddendaReq, BOOL *pbAddendaSeparator, BOOL *pbAddenda2Digit, BOOL *pbAddenda5Digit, BOOL *pbXmitNumSys Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 39...

  • Page 54: Oemgetsetupupce

    This function is used to get the UPC-E symbology-specific options. Result_t oemGetSetupUPCE ( SetupType_t SetupType, BOOL *pE0Enabled, BOOL *pE1Enabled, BOOL *pbXmitCheckDigit, BOOL *pbAddendaReq, BOOL *pbExpandVersionE, BOOL *pbAddendaSeparator, BOOL *pbAddenda2Digit, BOOL *pbAddenda5Digit, BOOL *pbXmitNumSys Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 40 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 55: Oemgetvideoreverse

    A pointer to a BOOL variable that will be set to TRUE if decoding of inverted symbols is enabled and FALSE if decoding of inverted symbols is disabled. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 41...

  • Page 56: Oemimagestreaminit

    Buffer in which the image data or image bitmap file data is returned on successful read of an image. pdwSize Pointer to a DWORD where the number of bytes placed in the image buffer is returned. 2 - 42 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 57: Oemimagestreamstop

    If TRUE, the illumination LEDs are turned on; otherwise they're turned off. oemPowerOffImager Note: This function is only available to certain applications, and is dependent upon the hardware that supplies switchable power to the imager (V). IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 43...

  • Page 58: Oemsetdecodeattemptlimit

    If TRUE, the centering is turned on; otherwise the centering is turned off. pIntersectRect Rectangular image region of which at least part of the decoded symbol must overlap to be considered a valid decode. 2 - 44 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 59: Oemsetdecodemode

    RESULT_ERR_UNSUPPORTED RESULT_ERR_DRIVER RESULT_ERR_PARAMETER Parameters ExposureMode The exposure modes that may be used are: fixed, on chip or Hand Held Products. oemSetExposureSettings This function is used to set various image parameters that are used during image acquisition. Result_t oemSetExposureSettings ( ExposureSettings_t *pExpsoureSettings...

  • Page 60: Oemsetlinearrange

    This function gives the user the ability to select what the illumination and aimer do during imaging. Result_t oemSetScanningLightsMode( ScanIlluminat_t nIllumMode Parameters ScanIlluminat SCAN_ILLUM_AIMER_OFF=0 SCAN_ILLUM_ONLY_ON SCAN_AIMER_ONLY_ON SCAN_ILLUM_AIMER_ON 2 - 46 Neither aimers nor illumination Illumination only Aimers only Both aimers and illumination IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 61: Oemsetsearchtimelimit

    3750. oemSetupChinaPost This function is used to set the China Post symbology-specific options. Result_t oemSetupChinaPost ( WORD nMinLength, WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 47...

  • Page 62: Oemsetupcodabar

    The maximum allowable value (as well as the default) is 60. oemSetupCodablock This function is used to set the Codablock symbology-specific options. Result_t oemSetupCodablock ( WORD nMinLength, WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 48 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 63: Oemsetupcode11

    The maximum length decoded Code 128 message the engine should return. Code 128 messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 80. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 49...

  • Page 64: Oemsetupcode16K

    This function is used to set the Code 39 symbology-specific options. Result_t oemSetupCode39 ( BOOL bSSXmit, BOOL bCheckCharOn, BOOL bXmitCheckChar, BOOL bFullAscii, BOOL bAppend, WORD nMinLength, WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 50 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 65: Oemsetupcode49

    The maximum length decoded Code 49 message the engine should return. Code 49 messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 81. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 51...

  • Page 66: Oemsetupcode93

    This function is used to set the EANoUCC Composite, as well as other Composite symbology-specific options. Result_t oemSetupCompositeEx ( WORD nMinLength, WORD nMaxLength, BOOL bCompositeOnUpcEan Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 2 - 52 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 67: Oemsetupdatamatrix

    The maximum allowable value (as well as the default) is 1500. oemSetupEAN8 This function is used to set the EAN-8 symbology-specific options. Result_t oemSetupEAN8 ( BOOL bXmitCheckChar, BOOL bAddenda2Digit, BOOL bAddenda5Digit, BOOL bAddendaReq, BOOL bAddendaSeparator Return Values RESULT_SUCCESS IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 53...

  • Page 68: Oemsetupean13

    Points to a BOOL variable that determines if there is a space character between the data from the bar code and the data from the addenda. If TRUE, there is a space. If FALSE, there is no space. The default value is TRUE. 2 - 54 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 69: Oemsetupiata25

    The maximum length decoded Interleaved 2 of 5 message the engine should return. Interleaved 2 of 5 messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 80. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 55...

  • Page 70: Oemsetupkoreanpost

    The maximum length decoded Maxicode message the engine should return. Maxicode messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 150. 2 - 56 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 71: Oemsetupmesa

    The maximum length decoded MicroPDF417 message the engine should return. MicroPDF417 messages larger than this maximum length are not reported by the engine. The maximum allowable value (as well as the default) is 2750. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide oemSetupAztec (page 2-47).

  • Page 72: Oemsetupmsi

    The maximum length decoded Matrix 2 of 5 message the engine should return. Matrix 2 of 5 messages larger than this maximum length are reported by the engine. The maximum allowable value (as well as the default) is 80. 2 - 58 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 73: Oemsetupocr

    "0, 6, 8," and "9." The constant specifies the direction taken when the operator reads the message from start to finish. The following values are used: LeftToRight TopToBottom RightToLeft BottomToTop IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 59...

  • Page 74: Oemsetuppdf417

    The maximum length decoded Plessey Code message the engine should return. Plessey Code messages larger than this maximum length are reported by the engine. The maximum allowable value (as well as the default) is 48. 2 - 60 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 75: Oemsetupposicode

    The default value is FALSE. oemSetupQR This function is used to set the QR Code symbology-specific options. Result_t oemSetupQR ( WORD nMinLength, WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 61...

  • Page 76: Oemsetuprss

    The maximum length decoded Straight 2 of 5 message the engine should return. Straight 2 of 5 messages larger than this maximum length are reported by the engine. The maximum allowable value (as well as the default) is 48. 2 - 62 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 77: Oemsetuptelepen

    This function is used to set the UPC-A symbology-specific options. Result_t oemSetupUPCA ( BOOL bXmitCheckDigit, BOOL bXmitNumSys, BOOL bAddenda2Digit, BOOL bAddenda5Digit, BOOL bAddendaReq, BOOL bAddendaSeparator Return Values RESULT_SUCCESS IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 63...

  • Page 78: Oemsetupupce

    This function is used to set the UPC-E symbology-specific options. Result_t oemSetupUPCE ( BOOL bXmitCheckDigit, BOOL bXmitNumSys, BOOL bExpandVersionE, BOOL bAddenda2Digit, BOOL bAddenda5Digit, BOOL bAddendaReq, BOOL bAddendaSeparator Return Values RESULT_SUCCESS 2 - 64 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 79: Oemsetvideoreverse

    Imager, the IQ Image will still be right side up. Note, however, if the specified image is outside the field of view, a result code of RESULT_ERR_BADREGION will be returned. The user could then be prompted to adjust his aim and try again. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 65...
  • Page 80 Bar Code Height Narrow Element Width (Intelligent Bar Code Unit) Result_t oemStartIntellImgXfer ( const IntellImgDesc_t *pImageDesc Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER RESULT_ERR_BADREGION RESULT_ERR_BADSMARTIMAGE RESULT_ERR_SMARTIMAGETOOLARGE 2 - 66 -Y axis Image of Interest IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide +X axis...

  • Page 81: Oemwaitfordecode

    BOOL (*fpCallBack) (void) Return Values RESULT_SUCCESS RESULT_ERR_ENGINEBUSY RESULT_ERR_PARAMETER RESULT_ERR_NOTRIGGER RESULT_ERR_NODECODE RESULT_ERR_NOIMAGE IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2-65). Raw data that's converted to 2 gray levels Raw data that's converted to 256 gray levels 2 - 67...

  • Page 82: Oemwaitfordecoderaw

    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 pchCodeID Upon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. See Symbology Identifiers (page 3-1).

  • Page 83: Oemwaitmultipledecode

    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 pchCodeID Upon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. See Symbology Identifiers (page 3-1).

  • Page 84: Oemwaitmultipledecoderaw

    If this callback returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecodeRaw returns. Setting this parameter to NULL causes the decoder to ignore the use of this callback during execution. 2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...
  • Page 85 Reduced Space Symbology (RSS-14, RSS Limited, RSS Expanded) Straight 2 of 5 IATA (two-bar start/ stop) TCIF Linked Code 39 (TLC39) UPC-A UPC-E UPC-E1 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide Selection Definition SYM_AUSPOST ]z m SYM_AZTEC SYM_AZTEC ]z m SYM_BPO...

  • Page 86: Function Result Values

    The API function was unable to return with valid image data. The API function terminated the decode due to a user- supplied callback function, such as trigger up callback). The API function failed because one or more parameters were invalid. IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide...

  • Page 87: Chapter 4 - Customer Support

    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...
  • Page 88 4 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK)
  • Page 90 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...

This manual is also suitable for:

It4000It4100It4300

Table of Contents