Hand Held Products 4X00 OemGetAPIRevision, OemGetDecodeAttemptLimit, OemGetDecodeCenteringWindow

Page 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, specified in milliseconds, is the maximum amount of time the decoder may use to attempt a decode on the current image.

Result_t oemGetDecodeAttemptLimit (

SetupType_t SetupType, WORD *nLimit

)

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 decode attempt maximum time limit. A value of zero indicates no limit.

oemGetDecodeCenteringWindow

This function returns the Enabled/Setup information for decode centering mode. In this mode, a decode call is only successful if the area bounding the decoded symbol intersects a caller defined rectangle located about the center of the captured image.

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

Image 18
Contents User’s Guide Disclaimer Table of Contents Page Symbology Identifiers Page Introduction Features of the 4X00 Series Image Engine API Library Summary Page Page Data Type Definitions Tchar Page OemAcquireImage OemAimerOnOemDefaultSymbology OemDisableSymbologyOemConnect OemEnableSymbologyAll OemDisableSymbologyAllOemEnableSymbology OemDisconnectOemGetAPIRevision OemGetDecodeAttemptLimitOemGetDecodeCenteringWindow OemGetDecodeMode OemGetDecoderRevisionOemGetDecodeTime Resultt oemGetErrorMessage OemGetErrorMessageOemGetExposureSettings Resultt oemGetExposureSettingsOemGetImage Resultt oemGetImagePrototype Resultt oemGetImageData OemGetImageDataOemGetImagerInfo Resultt oemGetImagerInfoResultt oemGetImagerProperties OemGetImagerPropertiesPnCols PImgPropResultt oemGetLastImage OemGetLastImageOemGetLastImageExt Resultt oemGetLastImageExtResultt oemGetLastImageSize OemGetLastImageSizeOemGetLeaveLightsOn Resultt oemGetLeaveLightsOnOemGetPrintWeight OemGetLinearRangeOemGetMaxMessageChars OemGetSetupAll OemGetScanDriverRevisionOemGetSearchTimeLimit OemGetSetupAusPost OemGetSetupAztecOemGetSetupBPO Resultt oemGetSetupCanPost OemGetSetupCanPostOemGetSetupChinaPost Resultt oemGetSetupChinaPostResultt oemGetSetupCodabar OemGetSetupCodabarOemGetSetupCodablock Resultt oemGetSetupCodablockOemGetSetupCode11 Resultt oemGetSetupCode11Resultt oemGetSetupCode128 OemGetSetupCode128OemGetSetupCode16K Resultt oemGetSetupCode16KResultt oemGetSetupCode32 OemGetSetupCode32OemGetSetupCode39 Resultt oemGetSetupCode39PbFullAscii OemGetSetupCode49Resultt oemGetSetupCode49 PbAppendResultt oemGetSetupCode93 OemGetSetupCode93OemGetSetupComposite Resultt oemGetSetupCompositeOemGetSetupCompositeEx Resultt oemGetSetupCompositeExPbCompositeOnUpcEan Resultt oemGetSetupCouponCode OemGetSetupCouponCodeOemGetSetupDataMatrix Resultt oemGetSetupDataMatrixResultt oemGetSetupDutchPost OemGetSetupDutchPostOemGetSetupEAN8 Resultt oemGetSetupEAN8OemGetSetupEAN13 OemGetSetupIATA25 Resultt oemGetSetupIATA25Prototype Resultt oemGetSetupImager OemGetSetupImagerOemGetSetupInt25 Resultt oemGetSetupInt25OemGetSetupISBT OemGetSetupJapostOemGetSetupKoreanPost OemGetSetupMaxicode Resultt oemGetSetupMaxicodePCarrierMsgOnly OemGetSetupMesa Resultt oemGetSetupMesaP9MSEnabled OemGetSetupMSI Resultt oemGetSetupMSIPMinLength PMaxLength Resultt oemGetSetupMx25 OemGetSetupMx25OemGetSetupOCR Resultt oemGetSetupOCRPszGroupG PszGroupHPszCheckChar Resultt oemGetSetupPlanet OemGetSetupPlanetOemGetSetupPlessey Resultt oemGetSetupPlesseyOemGetSetupPosiCode Resultt oemGetSetupPosiCodePLimited Resultt oemGetSetupPostnet OemGetSetupPostnetOemGetSetupQR Resultt oemGetSetupQRResultt oemGetSetupRSS OemGetSetupRSSOemGetSetupStrt25 Resultt oemGetSetupStrt25Resultt oemGetSetupTelepen OemGetSetupTelepenOemGetSetupTLC39 Resultt oemGetSetupTLC39Resultt oemGetSetupTrioptic OemGetSetupTriopticOemGetSetupUPCA Resultt oemGetSetupUPCAOemGetSetupUPCE Resultt oemGetSetupUPCEOemGetVideoReverse PE0EnabledPE1Enabled PbExpandVersionEOemImageStreamInit OemImageStreamStartOemImageStreamRead OemLeaveLightsOn OemPowerOffImagerOemImageStreamStop OemLightsOnOemSetDecodeCenteringWindow Resultt oemPowerOffImagerOemSetDecodeAttemptLimit Resultt oemSetDecodeAttemptLimitOemSetExposureSettings OemSetDecodeModeOemSetExposureMode OemSetScanningLightsMode OemSetPrintWeightOemSetLinearRange Resultt oemSetLinearRangeOemSetupAztec OemSetupChinaPostOemSetSearchTimeLimit Resultt oemSetupCodabar OemSetupCodabarOemSetupCodablock Resultt oemSetupCodablockResultt oemSetupCode11 OemSetupCode11OemSetupCode128 Resultt oemSetupCode128Resultt oemSetupCode16K OemSetupCode16KOemSetupCode39 Resultt oemSetupCode39BFullAscii OemSetupCode49Resultt oemSetupCode49 BAppendOemSetupCode93 OemSetupCompositeOemSetupCompositeEx Resultt oemSetupDataMatrix OemSetupDataMatrixOemSetupEAN8 Resultt oemSetupEAN8OemSetupEAN13 Resultt oemSetupEAN13BAddendaReq Resultt oemSetupIATA25 OemSetupIATA25OemSetupInt25 Resultt oemSetupInt25Resultt oemSetupKoreanPost OemSetupKoreanPostOemSetupMaxicode Resultt oemSetupMaxicodeOemSetupMesa Resultt oemSetupMesaResultt oemSetupMSI OemSetupMSIOemSetupMx25 Resultt oemSetupMx25NFont OemSetupOCRResultt oemSetupOCR PszTemplateResultt oemSetupPlanet OemSetupPlanetOemSetupPlessey Resultt oemSetupPlesseyOemSetupPosiCode OemSetupPostnetOemSetupQR Resultt oemSetupRSS OemSetupRSSOemSetupStrt25 Resultt oemSetupStrt25Resultt oemSetupTelepen OemSetupTelepenOemSetupUPCA Resultt oemSetupUPCAOemSetupUPCE Resultt oemSetupUPCEBXmitNumSys OemStartIntellImgXfer BEnabledOemSetVideoReverse BExpandVersionEResultt oemStartIntellImgXfer OemWaitForDecode Resultt oemWaitForDecodeOemWaitForDecodeRaw Resultt oemWaitForDecodeRawOemWaitMultipleDecode Resultt oemWaitMultipleDecodeFpContinueCallBack OemWaitMultipleDecodeRawFpMultiReadCallBack Resultt oemWaitMultipleDecodeRawSymbology Identifiers Function Result Values Mail latechsupport@handheld.com Mail eutechsupport@handheld.comMail aptechsupport@handheld.com Imageteam 4X00 Series Software Development Kit SDK Page Hand Held Products, Inc