Resumen del contenido incluido en la página 1
™
IMAGETEAM 4X00 Series
For Adaptus Imaging Technology Imagers:
IT4000, IT4100, and IT4300
Software Development Kit (SDK)
User’s Guide
Resumen del contenido incluido en la página 2
Disclaimer Hand Held Products, Inc. d/b/a Hand Held Products (“Hand Held Products”) reserves the right to make changes in specifications and other information contained in this document without prior notice, and the reader should in all cases consult Hand Held Products to determine whether any such changes have been made. The information in this publication does not represent a commitment on the part of Hand Held Products. Hand Held Products shall not be liable for technical or editorial err
Resumen del contenido incluido en la página 3
Table of Contents Chapter 1 - Introduction Design Overview .................................................................................................................................1-1 User Layer.....................................................................................................................................1-1 OEM API Layer ............................................................................................................................1-1 Image Acquisition L
Resumen del contenido incluido en la página 4
oemGetSetupCode39 .................................................................................................................2-19 oemGetSetupCode49 .................................................................................................................2-20 oemGetSetupCode93 .................................................................................................................2-21 oemGetSetupComposite .......................................................................
Resumen del contenido incluido en la página 5
oemSetupCode128 .....................................................................................................................2-49 oemSetupCode16K ....................................................................................................................2-50 oemSetupCode39 .......................................................................................................................2-50 oemSetupCode49 .......................................................................
Resumen del contenido incluido en la página 6
iv
Resumen del contenido incluido en la página 7
1 Introduction This document is an overview of the structure of the IT4X00 Series OEM imaging software provided by Hand Held Products. Detailed information that describes the Hand Held Products OEM Application Programming Interface is provided as a part of the 4X00 Series. Design Overview The Hand Held Products OEM imaging software supports a number of different Hand Held Products imaging engines, while exposing the user to a common programming interface for all supported imagers. This appr
Resumen del contenido incluido en la página 8
Features of the 4X00 Series The 4X00 Series consists of the following: The API Definition and Documentation API Libraries Sample Code The 4X00 Series functions are defined on a higher level so they can be easily understood and integrated into your applications. The image/data capture engine is easily integrated. A single API is used for all Hand Held Products engines. Libraries are available for Windows CE 2.x and Windows CE 3.x. Sample source code is provided so you can see an ex
Resumen del contenido incluido en la página 9
Image Engine API Library Summary The following is a summary of the API functions. The full description of each of function is found on the page noted. Core Function Summary Description Page oemAimerOn Turn on/off the engine's aiming LEDs 2-1 oemConnect Initialize connection with engine device 2-2 oemDisconnect Close the connection to the engine device 2-3 2-4 oemGetAPIRevision Retrieve the API library's software revision information oemGetDecodeMode Retrieve the decoding mode of the engine 2-5
Resumen del contenido incluido en la página 10
oemGetSetupCodabar Gets the Codabar symbology decoding options 2-16 oemGetSetupCodablock Gets the Codablock symbology decoding options 2-16 oemGetSetupCode11 Gets the Code 11 symbology decoding options 2-17 oemGetSetupCode128 Gets the Code 128 symbology decoding options 2-18 oemGetSetupCode16K Gets the Code 16K symbology decoding options 2-18 oemGetSetupCode32 Gets the Code 32 symbology decoding options 2-19 oemGetSetupCode39 Gets the Code 39 symbology decoding options 2-19 oemGetSetupCode49 Get
Resumen del contenido incluido en la página 11
oemSetDecodeMode Sets the decoding mode of the engine 2-45 Sets the size of the window used in the Advanced Linear oemSetLinearRange 2-46 decoding mode Adjust the print weight or relative blackness that the decoder oemSetPrintWeight 2-46 expects Sets the maximum time limit for the decoders search oemSetSearchTimeLimit 2-47 processing oemSetupAztec Set the Aztec Code symbology decoding options 2-47 oemSetupChinaPost Set the Chinese Postal Code symbology decoding options 2-47 oemSetupCodabar Se
Resumen del contenido incluido en la página 12
The engine scans until a symbol is decoded, or a timeout is oemWaitForDecodeRaw 2-68 reached - decoded message is returned in raw form oemWaitMultipleDecode Reads multiple symbols using a single function call 2-69 Reads multiple symbols using a single function call - decoded oemWaitMultipleDecodeRaw 2-70 message is returned in raw form Imaging Functions oemAcquireImage Acquires an image but does not return it. 2-1 oemGetExposureSettings Retrieves image parameters used during image acquisition.
Resumen del contenido incluido en la página 13
Variable Description Enumerated integer type that defines API function result values. See Function Result Result_t Values on page 3-2. Enumerated integer type that identifies possible illumination modes used during image ScanIlluminat_t 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. IMAGETEAM™ 4X00 Series Softwar
Resumen del contenido incluido en la página 14
1 - 8 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide
Resumen del contenido incluido en la página 15
2 API Function Descriptions The following is an alphabetic listing of each API function with its complete description and a prototype for each function. All API functions return a result code of type Result_t. See Function Result Values on page 3-2 for a table of result code values. oemAcquireImage This function tells the Imager to acquire an image, but does not return the image. Result_t oemAcquireImage ( const ImagerSetup_t *pImagerSetup ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORT
Resumen del contenido incluido en la página 16
Parameters bEnable If TRUE, the aiming mechanism is turned on; otherwise the aiming mechanism is turned off. oemConnect The application should call this function before any other API functions. Once an application has connected to the engine, all other API functions can be successfully called. The application does not need to re-connect to the engine unless it has called oemDisconnect (page 9). Result_t oemConnect ( ) Return Values RESULT_SUCCESS RESULT_ERR_DRIVER Parameters All Reserved,
Resumen del contenido incluido en la página 17
oemDisableSymbologyAll This function disables all symbologies from decoding, including any unknown symbologies. Result_t oemDisableSymbologyAll ( void ) Return Values RESULT_SUCCESS Parameters None. oemDisconnect This function terminates the connection with the engine. Any resources used by the connection device driver are freed. Result_t oemDisconnect ( void ) Return Values RESULT_SUCCESS Parameters None. oemEnableSymbology This function enables specified symbologies for decoding. Result_t
Resumen del contenido incluido en la página 18
oemGetAPIRevision This function returns an ASCII string containing the API's current revision. Result_t oemGetAPIRevision ( TCHAR *pszRev ) Return Values RESULT_SUCCESS always Parameters pszRev Upon successful return, this null-terminated string is filled in with the revision level of the API. The caller must allocate at least ENGINE_API_RESPONSE_LEN bytes for this string. oemGetDecodeAttemptLimit This function is used to retrieve the current decode attempt maximum time limit. The limit, s
Resumen del contenido incluido en la página 19
Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default settings. PbEnabled Pointer to a BOOL which returns TRUE if centering mode enabled or FALSE if it's not. oemGetDecodeMode This function retrieves the decoding mode of the engine. Result_t oemGetDecodeMode ( SetupType_t SetupType, WORD *pnMode ) Return Values RESULT_SUCCESS RESULT_ERR_UNSUPPORTED Parameters SetupType SETUP_TYPE_CURRENT for current settings, or SETUP_TYPE_DEFAULT for default sett
Resumen del contenido incluido en la página 20
oemGetErrorMessage This function returns a string containing the description of the error corresponding to the nError parameter. Result_t oemGetErrorMessage ( TCHAR *pszErrorMsg, Result_t nError ) Return Values RESULT_SUCCESS always Parameters pszErrorMsg Upon successful return, this null-terminated string is filled in with text describing the error identified by the nError parameter. The caller must allocate at least ENGINE_API_RESPONSE_LEN bytes for this string. nError A value returned f
