Hand-held-products 4X00 Manual de usuario

IMAGETEAM™ 4X00 SeriesFor Adaptus Imaging Technology Imagers:IT4000, IT4100, and IT4300Software Development Kit (SDK)User’s Guide

1 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupCodabar Gets the Codabar symbology decoding options 2-16oemGetSetup

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 5oemSetDecodeMode Sets the decoding mode of the engine 2-45oemSetLinearRangeSet

1 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideData Type DefinitionsThroughout this document the following variable types are

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 7Result_tEnumerated integer type that defines API function result values. See

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

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 12API Function DescriptionsThe following is an alphabetic listing of each API f

2 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersbEnableIf TRUE, the aiming mechanism is turned on; otherwise the aim

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 3oemDisableSymbologyAllThis function disables all symbologies from decoding, in

2 - 4 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetAPIRevisionThis function returns an ASCII string containing the API&apos

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 5ParametersSetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DE

DisclaimerHand Held Products, Inc. d/b/a Hand Held Products (“Hand Held Products”) reserves the right to make changes in specifications and other info

2 - 6 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetErrorMessageThis function returns a string containing the description of

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 7oemGetImageThis function retrieves an image from the engine and stores it in m

2 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuidenExposeAttemptsThe number of attempts the unit makes to get the image to the c

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 9ParameterspnColsUpon successful return, this variable points to the number of

2 - 10 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetLastImageThis function is used to retrieve the last image acquired by t

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 11oemGetLastImageSizeThis function returns the number of rows, number of column

2 - 12 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetLinearRangeThis function is used to get the size of the window used in

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 13oemGetScanDriverRevisionThis function returns the revision of the scan driver

2 - 14 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupAusPostThis function is used to get the Australian Postal Code sym

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 15Return ValuesRESULT_SUCCESSRESULT_ERR_PARAMETERParametersSetupTypeSETUP_TYPE_

iChapter 1 - IntroductionDesign Overview ...

2 - 16 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupCodabarThis function is used to get the Codabar symbology-specific

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 17ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 18 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupCode128This function is used to get the Code 128 symbology-specifi

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 19oemGetSetupCode32This function is used to get the Code 32 symbology specific

2 - 20 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 21ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 22 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 23oemGetSetupCouponCodeThis function is used to get the UPC-A with extended Cou

2 - 24 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupDutchPostThis function is used to get theKIX (Netherlands) Post sy

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 25ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

iioemGetSetupCode39 ...2-19oemGetSetupCo

2 - 26 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 27oemGetSetupImagerThis function gets the current Imager setup values.Prototype

2 - 28 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupISBTThis function is used to get the ISBT 128 symbology-specific o

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 29ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 30 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupMesaThis function is used to get the Aztec Mesa Code symbology-spe

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 31ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 32 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupMx25This function is used to get the Matrix 2 of 5 symbology speci

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 33ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 34 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 35ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

iiioemSetupCode128 ...2-49oemSetupCo

2 - 36 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupPostnetThis function is used to get the Postnet symbology-specific

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 37oemGetSetupRSSThis function is used to get the RSS Expanded symbology-specifi

2 - 38 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemGetSetupTelepenThis function is used to get the Telepen symbology specifi

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 39oemGetSetupTriopticThis function is used to get the Trioptic Code symbology s

2 - 40 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 41ParametersSetupTypeSETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEF

2 - 42 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemImageStreamInitThis function is used to intialize the image stream interfa

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 43oemImageStreamStopThis function causes the Image Engine to stop continous col

2 - 44 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideThis function allows the application to fully power down the imager for addit

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 45oemSetDecodeModeThis function sets the decoding mode of the engine.Result_t

iv

2 - 46 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetLinearRangeThis function sets the size of the window used in the Advanc

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 47oemSetSearchTimeLimitThis function is used to set the maximum time limit for

2 - 48 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersnMinLengthThe minimum length decoded China Post message the engine

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 49ParametersnMinLengthThe minimum length decoded Codablock message the engine s

2 - 50 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetupCode16KThis function is used to set the Code 16K symbology-specific o

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 51ParametersbSSXmitPoints to a BOOL variable that determines if the start and s

2 - 52 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetupCode93This function is used to set the Code 93 symbology-specific opt

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 53ParametersnMinLengthThe minimum length decoded EANoUCC Composite message the

2 - 54 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersbXmitCheckCharPoints to a BOOL variable that determines if the engi

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 55oemSetupIATA25This function is used to set the Straight 2 of 5 IATA symbology

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 11IntroductionThis document is an overview of the structure of the IT4X00 Serie

2 - 56 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetupKoreanPostThis function is used to set the Korean Post symbology-spec

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 57oemSetupMesaThis function is used to set the Aztec Mesa Code symbology-specif

2 - 58 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetupMSIThis function is used to set the MSI symbology-specific options. R

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 59oemSetupOCRThis function is used to set the Optical Character Recognition (OC

2 - 60 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideoemSetupPDF417This function is used to set the PDF417 symbology-specific opti

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 61oemSetupPosiCodeThis function is used to set the PosiCode symbology-specific

2 - 62 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersnMinLengthThe minimum length decoded QR Code message the engine sho

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 63oemSetupTelepenThis function is used to set the Telepen symbology-specific op

2 - 64 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersbXmitCheckDigitPoints to a BOOL variable that determines if the eng

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 65ParametersbXmitCheckDigitPoints to a BOOL variable that determines if the eng

1 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideFeatures of the 4X00 SeriesThe 4X00 Series consists of the following:• The API

2 - 66 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideThis function uses the dimensions of the bar code as its coordinate system.

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 67ParameterspImageDescPointer to a data structure describing the image to to be

2 - 68 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersdwTimeoutTime in milliseconds that the engine scans until finding a

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 69ParametersdwTimeoutTime in milliseconds that the engine scans until finding a

2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersdwTimeoutMaximum amount of time in milliseconds that the decoder ma

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 3 - 13Symbology IdentifiersSymbology IdentifiersThe following symbology identifiers

3 - 2 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideFunction Result ValuesThe following function result values are a sample of the

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) 4 - 14Customer SupportTechnical AssistanceIf you need assistance using the SDK, please call your

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

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 1 - 3Image Engine API Library SummaryThe following is a summary of the API function

™ Hand Held Products, Inc.700 Visions DriveP.O. Box 208Skaneateles Falls, NY 13153-02084X00SDK-UG Rev A6/05Note: This document replaces the OEMAPI-