Hand Held Products 4X00 Software Manual Download Page 6

Page: 6 / 90

Summary of Contents for 4X00

Page 1: ...IMAGETEAM 4X00 Series For Adaptus Imaging Technology Imagers IT4000 IT4100 and IT4300 Software Development Kit SDK User s Guide ...

Page 2: ...amages resulting from the furnishing performance or use of this material This document contains proprietary information which is protected by copyright All rights are reserved No part of this document may be photocopied reproduced or translated into another language without the prior written consent of Hand Held Products 2000 2005 Hand Held Products Inc All rights reserved Web Address www handheld...

Page 3: ...ringWindow 2 4 oemGetDecodeMode 2 5 oemGetDecoderRevision 2 5 oemGetDecodeTime 2 5 oemGetErrorMessage 2 6 oemGetExposureSettings 2 6 oemGetImage 2 7 oemGetImageData 2 8 oemGetImagerInfo 2 8 oemGetImagerProperties 2 9 oemGetLastImage 2 10 oemGetLastImageExt 2 10 oemGetLastImageSize 2 11 oemGetLeaveLightsOn 2 11 oemGetLinearRange 2 12 oemGetMaxMessageChars 2 12 oemGetPrintWeight 2 12 oemGetScanDrive...

Page 4: ...etSetupPlessey 2 34 oemGetSetupPosiCode 2 35 oemGetSetupPostnet 2 36 oemGetSetupQR 2 36 oemGetSetupRSS 2 37 oemGetSetupStrt25 2 37 oemGetSetupTelepen 2 38 oemGetSetupTLC39 2 38 oemGetSetupTrioptic 2 39 oemGetSetupUPCA 2 39 oemGetSetupUPCE 2 40 oemGetVideoReverse 2 41 oemImageStreamInit 2 42 oemImageStreamStart 2 42 oemImageStreamRead 2 42 oemImageStreamStop 2 43 oemLeaveLightsOn 2 43 oemLightsOn 2...

Page 5: ...pMx25 2 58 oemSetupOCR 2 59 oemSetupPDF417 2 60 oemSetupPlanet 2 60 oemSetupPlessey 2 60 oemSetupPosiCode 2 61 oemSetupPostnet 2 61 oemSetupQR 2 61 oemSetupRSS 2 62 oemSetupStrt25 2 62 oemSetupTelepen 2 63 oemSetupUPCA 2 63 oemSetupUPCE 2 64 oemSetVideoReverse 2 65 oemStartIntellImgXfer 2 65 oemWaitForDecode 2 67 oemWaitForDecodeRaw 2 68 oemWaitMultipleDecode 2 69 oemWaitMultipleDecodeRaw 2 70 Cha...

Page 6: ...iv ...

Page 7: ...s the 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 Image Acquisition Layer The Image Acquisition Software layer is the software supplied by Hand Held Products that is responsible for imager auto detection init...

Page 8: ... 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 Sample source code is provided so you can see an example of how to use the API functions Target Operating Systems for the 4X00 Series The 4X00 Series is design...

Page 9: ...ctory default settings 2 2 oemDisableSymbology Disable decoding of specific bar code symbologies 2 2 oemDisableSymbologyAll Disable decoding of all symbologies including unknown symbologies 2 3 oemEnableSymbology Enable decoding of specific bar code symbologies 2 3 oemEnableSymbologyAll Enable decoding of all symbologies including unknown symbologies 2 3 oemGetDecodeAttemptLimit Retrieves the curr...

Page 10: ...ymbology decoding options 2 28 oemGetSetupKoreanPost Gets the Korean Postal Code symbology decoding options 2 28 oemGetSetupMaxicode Gets the MaxiCode symbology decoding options 2 29 oemGetSetupMesa Gets the Aztec Mesa symbology decoding options 2 30 oemGetSetupMicroPDF Gets the MicroPDF417 symbology decoding options 2 30 oemGetSetupMSI Gets the MSI symbology decoding options 2 31 oemGetSetupMx25 ...

Page 11: ...oding options 2 53 oemSetupEAN13 Set the EAN 13 symbology decoding options 2 54 oemSetupIATA25 Set the IATA 2 of 5 symbology decoding options 2 55 oemSetupInt25 Set the Interleaved 2 of 5 symbology decoding options 2 55 oemSetupKoreanPost Set the Korean Postal Code symbology decoding options 2 56 oemSetupMaxicode Set the MaxiCode symbology decoding options 2 56 oemSetupMesa Set the Aztec Mesa symb...

Page 12: ...the current imager setup values 2 27 oemImageStreamInit Intialize image streaming interface 2 42 oemImageStreamRead Retrieve current image 2 42 oemImageStreamStart Start imager acquiring images 2 42 oemImageStreamStop Tell imager to stop acquiring images 2 43 oemStartIntellImgXfer Starts an IQ image transfer 2 65 Variable Description BOOL OS dependent size Boolean variable 1 true 0 false BYTE 8 bi...

Page 13: ...alues 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 Variable Description ...

Page 14: ...1 8 IMAGETEAM 4X00 Series Software Development Kit SDK User s Guide ...

Page 15: ...d ImagerSetup _t NumUpdates The Imager takes multiple images attempting to reach a target white value in the image while adjusting its gain and exposure settings This limits the number of attempts Exposure Maximum allowable exposure setting for the Imager The greater the exposure the more light and hence the brighter the image However it also increases motion sensitivity Gain Maximum allowable gai...

Page 16: ...default setting for a particular symbology Result_t oemDefaultSymbology BOOL pSymbology Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pSymbology Points to an array of symbologies you want to default For example if a value is set to 1 i e pSymbology SYM_AZTEC 1 then Aztec symbology is defaulted Note The array must be of size MAX_SYMBOLOGIES Defined in Oemdecodece h You must initializ...

Page 17: ... oemEnableSymbology This function enables specified symbologies for decoding Result_t oemEnableSymbology BOOL pSymbology Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pSymbology Points to an array of symbologies you want to enable For example if a value is set to 1 i e pSymbology SYM_AZTEC 1 then Aztec decoding is enabled Note The array must be of size MAX_SYMBOLOGIES Defined in Oem...

Page 18: ...T_SUCCESS RESULT_ERR_UNSUPPORTED RESULT_ERR_PARAMETER Parameters Setup Type SETUP_TYPE_CURRENT for current settings or SETUP_TYPE_DEFAULT for default settings pnLimit Points to a word variable that upon return of RESULT_SUCCESS will contain the decode attempt maximum time limit A value of zero indicates no limit oemGetDecodeCenteringWindow This function returns the Enabled Setup information for de...

Page 19: ...lled in with status for the decode mode 1 Standard 2 Advanced Linear 4 Quick Omni oemGetDecoderRevision This function returns an ASCII string containing the decoder s current revision Result_t oemGetDecoderRevision TCHAR pszRev Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pszRev Upon successful return this null terminated string is filled with the revision level of the decoder soft...

Page 20: ... parameter The caller must allocate at least ENGINE_API_RESPONSE_LEN bytes for this string nError A value returned from another API function call oemGetExposureSettings This function is used to retrieve the various image parameters that are used during image acquisition Result_t oemGetExposureSettings ExposureSettings_t pExpsoureSettings Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED RESULT_E...

Page 21: ...ransferred image The upper left pixel has both an nLeft and an nTop value of 0 nRight nBottom Coordinates relative to the image engine s pixel grid for last pixel of the transferred image nSkip When transferring an image transfer every nSkip pixel nBits The color depth for the transferred image Valid values are typically only 8 or 1 but this depends on the engine hardware Independent of the bits u...

Page 22: ...unction gets data from the Imager Each subsequent call fills the supplied buffer with image data The end of the image data is identified by a GetImageData call that does not fill the buffer less than BufferSize bytes were placed in the buffer and has a return of RESULT_SUCCESS Prototype Result_t oemGetImageData DWORD dwNumberToRead BYTE pBuffer DWORD pNumBytesRead Return Values RESULT_SUCCESS RESU...

Page 23: ...ture to be filled by this function with information about the imager typedef struct DWORD dwSize DWORD dwEngineID 0 DWORD dwImagerRows DWORD dwImagerCols DWORD dwBitsPerPixel DWORD dwRotation DWORD dwAimerXoffset DWORD dwAimerYoffset DWORD dwYDepth ImagerProperties_t dwSize Size of structure dwEngineID EngineIDs values TYPE_NONE 0 No imager hardware TYPE_IT4200 1 TYPE_IT4000 5 TYPE_IT4100 6 TYPE_I...

Page 24: ...ve the last image acquired by the image engine and the exposure parameters associated with that image Result_t oemGetLastImageExt BYTE pImageBuffer DWORD pImageSize ImageAttributes_t pImageAttributes 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_...

Page 25: ... Upon successful return this variable points to the total number of Image bytes oemGetLeaveLightsOn This function returns a parameter reflecting the operational mode of the illumination LEDs during scanning Result_t oemGetLeaveLightsOn SetupType_t SetupType BOOL pbEnable Return Values RESULT_SUCCESS RESULT_ERR_NOTCONNECTED RESULT_ERR_UNSUPPORTED RESULT_ERR_DRIVER RESULT_ERR_PARAMETER RESULT_ERR_NO...

Page 26: ...s WORD pnChars Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters pnChars Upon successful return this variable points to the number of characters not bytes required for the largest possible decode message In WindowsCE the character size is 2 bytes wchar_t oemGetPrintWeight This function returns the current or default Print Weight relative contrast expected by the decoder for barcodes or ...

Page 27: ...he current image Result_t oemGetSearchTimeLimit SetupType_t SetupType WORD pnLimit Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED RESULT_ERR_PARAMETER Parameters Setup Type SETUP_TYPE_CURRENT for current settings or SETUP_TYPE_DEFAULT for default settings pnLimit Points to a word variable that upon return of RESULT_SUCCESS will contain the maximum search time limit A value of zero indicates n...

Page 28: ... 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 pMinLength Points to a WORD variable that contains the minimum ...

Page 29: ...the symbology is enabled a FALSE means the symbology is disabled oemGetSetupChinaPost This function is used to get the China Post symbology specific options Result_t oemGetSetupChinaPost 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 ...

Page 30: ...d return Codabar messages larger than this maximum length are reported by the engine The default value is 60 pbSSXmit Points to a BOOL variable that determines if the start and stop characters are returned in the data string after a successful Codabar decode If bSSXmit is TRUE the start and stop characters are included If FALSE they are not included The default value is FALSE pbCheckCharOn Points ...

Page 31: ...value is FALSE oemGetSetupCode11 This function is used to get the Code 11 symbology specific options Result_t oemGetSetupCode11 SetupType_t SetupType BOOL pEnabled WORD pMinLength WORD pMaxLength BOOL pbXmitCheckChar 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 var...

Page 32: ...message the engine should return Code 128 messages larger than this maximum length are reported by the engine The default value is 80 oemGetSetupCode16K This function is used to get the Code 16K symbology specific options Result_t oemGetSetupCode16K SetupType_t SetupType BOOL pEnabled WORD pMinLength WORD pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_...

Page 33: ...PE_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 oemGetSetupCode39 This function is used to get the Code 39 symbology specific options Result_t oemGetSetupCode39 SetupType_t SetupType BOOL pEnabled WORD pMinLength WORD pM...

Page 34: ...ned as a single character If bFullAscii is TRUE interpretation is enabled If FALSE no interpretation is attempted The default value is FALSE pbAppend Points to a BOOL variable that determines if the engine should append together and buffer up Code 39 symbols that start with a space excluding the start and stop characters The engine stores the symbols in the order in which they are read It returns ...

Page 35: ...tupCode93 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 A TRUE means the symbology is enabled a FALSE mean...

Page 36: ...well as other Composite symbology specific options Result_t oemGetSetupCompositeEx SetupType_t SetupType BOOL pEnabled WORD pMinLength WORD pMaxLength BOOL pbCompositeOnUpcEan 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 ...

Page 37: ..._t oemGetSetupDataMatrix 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 A TRUE means the symbology is enabl...

Page 38: ...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 oemGetSetupEAN8 This function is used to get the EAN 8 symbology specific options Result_t oemGetSetupEAN8 SetupType_t SetupType BOOL pEnabled BOOL bXmi...

Page 39: ...arator 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 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 If TRUE and an addenda is present the engin...

Page 40: ...de If TRUE and an addenda is present the engine adds the two digit addenda data to the end of the message If FALSE the engine ignores addenda data The default value is FALSE bAddenda5Digit Points to a BOOL variable that determines if the engine will look for a 5 digit addenda at the end of the EAN bar code If TRUE and an addenda is present the engine adds the five digit addenda data to the end of ...

Page 41: ...bology is enabled a FALSE means the symbology is disabled pMinLength Points to a WORD variable that contains the minimum length decoded Interleaved 2 of 5 message the engine should return Interleaved 2 of 5 messages smaller than this minimum length are not reported by the engine The default value is 4 pMaxLength Points to a WORD variable that contains the maximum length decoded Interleaved 2 of 5 ...

Page 42: ... disabled oemGetSetupJapost This function is used to get the Japanese Post symbology specific options Result_t oemGetSetupJapost 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 symbol...

Page 43: ...ype BOOL pEnabled WORD pMinLength WORD pMaxLength BOOL pCarrierMsgOnly 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 s...

Page 44: ...bled Points to a BOOL variable that contains the enabled state of EAN13 Mesa TRUE Enabled FALSE Disabled p3MSEnabled Points to a BOOL variable that contains the enabled state of Code 39 Mesa TRUE Enabled FALSE Disabled p1MSEnabled Points to a BOOL variable that contains the enabled state of Code 128 Mesa TRUE Enabled FALSE Disabled pIMSEnabled Points to a BOOL variable that contains the enabled st...

Page 45: ...upType_t SetupType BOOL pEnabled WORD pMinLength WORD pMaxLength BOOL pbXmitCheckChar 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 FA...

Page 46: ...y is disabled pMinLength Points to a WORD variable that contains the minimum length decoded Matrix 2 of 5 message the engine should return Matrix 2 of 5 messages smaller than this minimum length are not reported by the engine The default value is 4 pMaxLength Points to a WORD variable that contains the maximum length decoded Matrix 2 of 5 message the engine should return Matrix 2 of 5 messages lar...

Page 47: ...ecified in group H pszGroupG A null terminated string that represents a list of characters that can be substituted for the lower case g in the template strings pszGroupH A null terminated string that represents a list of characters that can be substituted for the lower case h in the template strings pszCheckChar A null terminated string that represents a check character position in the template st...

Page 48: ...etupPlanet This function is used to get the Planet Code symbology specific options Result_t oemGetSetupPlanet 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 symb...

Page 49: ...bled WORD pMinLength WORD pMaxLength WORD pLimited 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...

Page 50: ...t is not returned The default value is FALSE oemGetSetupQR This function is used to get the QR Code symbology specific options Result_t oemGetSetupQR 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 va...

Page 51: ...d return RSS messages larger than this maximum length are reported by the engine The default value is 80 oemGetSetupStrt25 This function is used to get the Straight 2 of 5 symbology specific options Result_t oemGetSetupStrt25 SetupType_t SetupType BOOL pEnabled WORD pMinLength WORD pMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters SetupType SETUP_TYPE_CURRENT for current sett...

Page 52: ...nimum length are not reported by the engine The default value is 1 pMaxLength Points to a WORD variable that contains the maximum length decoded Telepen message the engine should return Telepen messages larger than this maximum length are not reported by the engine The default value is 60 pOriginal Points to a BOOL variable that reflects if the engine is configured to reads Telepen labels that wer...

Page 53: ...P_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 oemGetSetupUPCA This function is used to get the UPC A symbology specific options Result_t oemGetSetupUPCA SetupType_t SetupType BOOL pEnabled BOOL pbXmitCheckChar BOOL...

Page 54: ...a space If FALSE there is no space The default value is FALSE pbAddenda2Digit Points to a BOOL variable that determines if the engine will look for a 2 digit addenda at the end of the UPC bar code If TRUE and an addenda is present the engine adds the two digit addenda data to the end of the message If FALSE the engine ignores addenda data The default value is FALSE pbAddenda5Digit Points to a BOOL...

Page 55: ...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 FALSE pbAddenda2Digit Points to a BOOL variable that determines if the engine will look for a 2 digit addenda at the end of the UPC bar code If TRUE and an addenda is present the engine adds the two digit ad...

Page 56: ...ge is to be inverted oemImageStreamStart This function causes the Image Engine to start continous collecting of images You must call oemImageStreamInit before calling this function Result_t oemImageStreamStart Return Values RESULT_SUCCESS RESULT_ERR_INITIALIZE Parameters None oemImageStreamRead This function returns the last image acquired The functions oemImageStreamInit and oemImageStreamStart m...

Page 57: ...ESULT_ERR_NOTCONNECTED RESULT_ERR_UNSUPPORTED RESULT_ERR_DRIVER RESULT_ERR_PARAMETER RESULT_ERR_NORESPONSE Parameters SetupType SETUP_TYPE_CURRENT for current settings or SETUP_TYPE_DEFAULT for default settings bEnable If FALSE the illumination 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...

Page 58: ...nt settings or SETUP_TYPE_DEFAULT for default settings nLimit The maximum amount of time the decoder may use to attempt a decode on the current image Valid range for nLimit is 1 10 000 A value of zero indicates no limit The default value is 0 oemSetDecodeCenteringWindow This function allows the caller to Enable Setup decode centering mode In this mode a decode call is only successful if the area b...

Page 59: ...used to select the exposure mode to be used during image acquisition Result_t oemSetExposureMode ExposureMode_t ExposureMode Return Values RESULT_SUCCESS 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 ar...

Page 60: ...tWeight This function returns the current or default Print Weight relative contrast expected by the decoder for barcodes or OCR text Result_t oemGetPrintWeight WORD nPrintWeight Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nPrintWeight Set the print weight relative blackness that the decoder expects to see when attempting to decode symbols or OCR text from an image Changing this va...

Page 61: ...no limit The default value is 0 oemSetupAztec This function is used to set the Aztec and Aztec Mesa Code symbology specific options Result_t oemSetupAztec WORD nMinLength WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Aztec or Aztec Mesa Code message the engine should return Aztec or Aztec Mesa Code messages smaller than this mini...

Page 62: ...that determines if the engine will read Codabar bar codes with or without check characters If TRUE the engine only decodes Codabar codes with a check character If FALSE the decoder decodes codes with or without a check character The default value is FALSE bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after a succes...

Page 63: ...ly one check digit The default value is TRUE nMinLength The minimum length decoded Code 11 message the engine should return Code 11 messages smaller than this minimum length are not reported by the engine The default value is 4 and the minimum allowable value is 1 nMaxLength The maximum length decoded Code 11 message the engine should return Code 11 messages larger than this maximum length are not...

Page 64: ...s minimum length are not reported by the engine The minimum allowable value as well as the default is 1 nMaxLength The maximum length decoded Code 16K message the engine should return Code 16K messages larger than this maximum length are reported by the engine The maximum allowable value as well as the default is 160 oemSetupCode39 This function is used to set the Code 39 symbology specific option...

Page 65: ...hin the bar code symbol are interpreted and returned as a single character If bFullAscii is TRUE interpretation is enabled If FALSE no interpretation is attempted The default value is FALSE bAppend Note This parameter is not supported and must be set to FALSE nMinLength The minimum length decoded Code 39 message the engine should return Code 39 messages smaller than this minimum length are not rep...

Page 66: ...function is used to set the EANoUCC Composite symbology specific options Result_t oemSetupComposite WORD nMinLength WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER 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...

Page 67: ...mSetupDataMatrix This function is used to set the Data Matrix symbology specific options Result_t oemSetupDataMatrix WORD nMinLength WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters nMinLength The minimum length decoded Data Matrix message the engine should return Data Matrix messages smaller than this minimum length are not reported by the engine The minimum allowable ...

Page 68: ...ault value is FALSE oemSetupEAN13 This function is used to set the EAN 13 symbology specific options Result_t oemSetupEAN13 BOOL bXmitCheckChar BOOL bAddenda2Digit BOOL bAddenda5Digit BOOL bAddendaReq BOOL bAddendaSeparator Return Values RESULT_SUCCESS Parameters bXmitCheckChar Points to a BOOL variable that determines if the engine will return the check character as part of the data string after ...

Page 69: ... bCheckDigitOn Points to a BOOL variable that determines if the engine will read Interleaved 2 of 5 bar codes with or without check characters If TRUE the engine only decodes Interleaved 2 of 5 codes with a check digit If FALSE the decoder decodes codes with or without a check digit The default value is FALSE bXmitCheckDigit Points to a BOOL variable that determines if the engine will return the c...

Page 70: ... This function is used to set the MaxiCode symbology specific options Result_t oemSetupMaxicode BOOL bCarrierMsgOnly WORD nMinLength WORD nMaxLength Return Values RESULT_SUCCESS RESULT_ERR_PARAMETER Parameters bCarrierMsgOnly 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 S...

Page 71: ...8 Mesa TRUE Enabled FALSE Disabled pIMSEnabled Points to a BOOL variable that contains the enabled state of Interleaved 2 of 5 Mesa TRUE Enabled FALSE Disabled p9MSEnabled Points to a BOOL variable that contains the enabled state of Code 93 Mesa TRUE Enabled FALSE Disabled oemSetupMicroPDF This function is used to set the MicroPDF417 symbology specific options Result_t oemSetupMicroPDF WORD nMinLe...

Page 72: ...oints 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 oemSetupMx25 This function is used to set the Matrix 2 of 5 symbology specific options Result_t oemSetupMx25 WORD nMinLength WORD nMaxLength ...

Page 73: ...haracter g any character specified in group G h any character specified in group H l alphabetic letter r delimits a row t delimits multiple templates pszGroupG A null terminated string that defines the set of characters matching group g in a template pszGroupH A null terminated string that defines the set of characters matching group h in a template pszCheckChar A null terminated string that defin...

Page 74: ... oemSetupPlanet BOOL bXmitCheckDigit Return Values RESULT_SUCCESS 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 oemSetupPlessey This function is used to set the Plessey Co...

Page 75: ...t is 48 nLimited A WORD variable used to enable the decoding of either Posicode Limited A or Posicode Limited B labels A value of 1 enables Posicode Limited A and a value of 2 enables Posicode Limited B A value of 0 disables decoding of both Limited A and Limited B The default value is 0 oemSetupPostnet This function is used to set the Postnet symbology specific options Result_t oemSetupPostnet BO...

Page 76: ...ges 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 RSS message the engine should return RSS messages larger than this maximum length are not reported by the engine The maximum allowable value as well as the default is 80 oemSetupStrt25 This function is used to set the Straight 2 of 5 symb...

Page 77: ...wable value as well as the default is 1 nMaxLength The maximum length decoded Telepen message the engine should return Telepen messages larger than this maximum length are reported by the engine The maximum allowable value as well as the default is 60 bOriginal A BOOL variable that configures the engine to read Telepen labels that were encoded with either the original or the AIM specification The ...

Page 78: ... is FALSE bAddenda5Digit Points to a BOOL variable that determines if the engine will look for a 5 digit addenda at the end of the UPC bar code If TRUE and an addenda is present the engine adds the five digit addenda data to the end of the message If FALSE the engine ignores addenda data The default value is FALSE bAddendaReq Points to a BOOL variable that determines if the engine will decode only...

Page 79: ...hat determines if the engine will decode only EAN bar codes that have a 2 or 5 digit addenda If TRUE the engine decodes only EAN symbols with an addenda If FALSE the engine decodes all enabled EAN symbols The default value is FALSE bAddendaSeparator 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...

Page 80: ... In the following figure the center of the image of interest is at location 20 18 its width is 28 and its height is 8 Again all values are in Intelligent Bar Code Units To convert measurements to Intelligent Bar Code Units recall that each Intelligent Bar Code Unit is equal to the narrow element width Thus use the following formula Val in Intelligent Bar code Units Measurement in Inches Size of an...

Page 81: ... image using Intelligent Bar Code Units resolution The number of pixels to use per Intelligent Bar Code Unit A higher resolution yields a better quality image but also a larger one The exact value of resolution required is dependent on how far away the Imager is from the image and how high the desired image quality format Format of image The following formats are supported FF_RAW_BINARY Raw data t...

Page 82: ...pCallBack Pass in this pointer to a parameterless BOOL returning function to allow for an external event that causes a return from oemWaitForDecode As long as the function pointed to by fpCallBack returns TRUE oemWaitForDecode continues to attempt to decode a symbol If the function pointed to by fpCallBack returns FALSE then oemWaitForDecode returns with a Result_t of RESULT_ERR_NOTRIGGER OemWaitF...

Page 83: ...s BOOL returning function to allow for an external event that causes a return from oemWaitForDecodeRaw As long as the function pointed to by fpCallBack returns TRUE oemWaitForDecodeRaw continues to attempt to decode a symbol If the function pointed to by fpCallBack returns FALSE then oemWaitForDecodeRaw returns with a Result_t of RESULT_ERR_NOTRIGGER OemWaitForDecodeRaw also returns if it gets a v...

Page 84: ...ion to pass the decoded data back to the calling application in raw form as byte values This function continues to find and decode symbols until the time specified in the dwTimeout parameter has expired or until one of the callback functions returns false Result_t oemWaitMultipleDecodeRaw DWORD dwTimeout BOOL pMultiReadCallBack DecodeMsgRaw_t BOOL pKeepGoingCallBack void Return Values RESULT_SUCCE...

Page 85: ...SYM_CODABLOCK Om 0 1 4 5 6 q 0x71 Code 11 SYM_CODE11 H3 h 0x68 Code 39 SYM_CODE32 Am 0 1 3 4 5 7 b 0x62 Code 49 SYM_CODE49 Tm 0 1 2 4 l 0x6C Code 93 and 93i SYM_CODE93 Gm 0 9 A Z a m i 0x69 Code 128 SYM_CODE128 Cm 0 1 2 4 j 0x6A Data Matrix SYM_DATAMATRIX dm 0 6 w 0x77 EAN 8 SYM_EAN8 E4 D 0x44 EAN 13 SYM_EAN13 E0 d 0x64 EAN UCC Composite SYM_COMPOSITE em 0 3 y 0x79 Interleaved 2 of 5 SYM_INT25 lm ...

Page 86: ...ailable 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 RESULT_ERR_MEMORY The API function was unable to allocate memory from OS RESULT_ERR_NODECODE The API function did not result in a decoded message RESULT_ERR_NOIMAGE The API function was unable to return with valid image data RESULT_ERR_NOTR...

Page 87: ...mail natechsupport handheld com America Latina Teléfono 704 998 3998 opción 8 E mail latechsupport handheld com Brazil Telephone 55 21 2176 0250 Fax 55 21 2176 0249 E mail suporte handheld com Europe Middle East and Africa Telephone European Ofc Int 31 0 40 79 99 393 U K Ofc Int 44 1925 240055 E mail eutechsupport handheld com Asia Pacific Telephone Int 852 3188 3485 or 2511 3050 E mail aptechsupp...

Page 88: ...4 2 IMAGETEAM 4X00 Series Software Development Kit SDK ...

Page 89: ......

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 ...

Search results

Summary of Contents for 4X00

Reviews:

Related manuals for 4X00

Brands by name

Popular brands

Hand Held Products 4X00, Software Manual

Search results

Summary of Contents for 4X00

Reviews:

Related manuals for 4X00

Brands by name

Popular brands