Hand Held Products 4X00 manual OemWaitMultipleDecodeRaw, FpMultiReadCallBack, FpContinueCallBack

Page 84

Parameters

dwTimeout

Maximum amount of time in milliseconds that the decoder may use to attempt to find and decode symbols.

fpMultiReadCallBack

Pointer to a callback function that takes a DecodeMsg_t variable as a parameter and returns a BOOL. Upon a successful decode, the decoder calls this function using the DecodeMsg_t variable to return the decode data. The return parameter from this function dictates if the decoder continues to look for additional symbols. If the callback function returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecode returns. If the return parameter is TRUE, the decoder continues to attempt decoding additional symbols.

fpContinueCallBack

Pointer to a callback function that takes no parameters and returns a BOOL. This callback function may be used to terminate decoding based on some application-specific event. As long as this function returns TRUE, oemWaitMultipleDecode continues to attempt decoding additional symbols. If this callback returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecode returns. Setting this parameter to NULL causes the decoder to ignore the use of this callback during execution.

oemWaitMultipleDecodeRaw

This function is used to read multiple symbols using a single function call. When called, this function attempts to find and decode unique symbols once, and use the multi-read callback function 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_SUCCESS

RESULT_ERR_UNSUPPORTED

RESULT_ERR_PARAMETER

RESULT_ERR_NOTRIGGER

Parameters

dwTimeout

Maximum amount of time in milliseconds that the decoder may use to attempt to find and decode symbols.

fpMultiReadCallBack

Pointer to a callback function that takes a DecodeMsgRaw_t variable as a parameter and returns a BOOL. Upon a successful decode, the decoder calls this function using the DecodeMsgRaw_t variable to return the decode data. The return parameter from this function dictates if the decoder continues to look for additional symbols. If the callback function returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecodeRaw returns. If the return parameter is TRUE, the decoder continues to attempt decoding additional symbols.

fpContinueCallBack

Pointer to a callback function that takes no parameters and returns a BOOL. This callback function may be used to terminate decoding based on some application-specific event. As long as this function returns TRUE, oemWaitMultipleDecodeRaw continues to attempt decoding additional symbols. 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

Image 84
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 OemDisableSymbologyAll OemEnableSymbologyOemEnableSymbologyAll OemDisconnectOemGetAPIRevision OemGetDecodeAttemptLimitOemGetDecodeCenteringWindow OemGetDecodeMode OemGetDecoderRevisionOemGetDecodeTime OemGetErrorMessage OemGetExposureSettingsResultt oemGetErrorMessage Resultt oemGetExposureSettingsOemGetImage Resultt oemGetImageOemGetImageData OemGetImagerInfoPrototype Resultt oemGetImageData Resultt oemGetImagerInfoOemGetImagerProperties PnColsResultt oemGetImagerProperties PImgPropOemGetLastImage OemGetLastImageExtResultt oemGetLastImage Resultt oemGetLastImageExtOemGetLastImageSize OemGetLeaveLightsOnResultt oemGetLastImageSize Resultt oemGetLeaveLightsOnOemGetPrintWeight OemGetLinearRangeOemGetMaxMessageChars OemGetSetupAll OemGetScanDriverRevisionOemGetSearchTimeLimit OemGetSetupAusPost OemGetSetupAztecOemGetSetupBPO OemGetSetupCanPost OemGetSetupChinaPostResultt oemGetSetupCanPost Resultt oemGetSetupChinaPostOemGetSetupCodabar OemGetSetupCodablockResultt oemGetSetupCodabar Resultt oemGetSetupCodablockOemGetSetupCode11 Resultt oemGetSetupCode11OemGetSetupCode128 OemGetSetupCode16KResultt oemGetSetupCode128 Resultt oemGetSetupCode16KOemGetSetupCode32 OemGetSetupCode39Resultt oemGetSetupCode32 Resultt oemGetSetupCode39OemGetSetupCode49 Resultt oemGetSetupCode49PbFullAscii PbAppendOemGetSetupCode93 OemGetSetupCompositeResultt oemGetSetupCode93 Resultt oemGetSetupCompositeOemGetSetupCompositeEx Resultt oemGetSetupCompositeExPbCompositeOnUpcEan OemGetSetupCouponCode OemGetSetupDataMatrixResultt oemGetSetupCouponCode Resultt oemGetSetupDataMatrixOemGetSetupDutchPost OemGetSetupEAN8Resultt oemGetSetupDutchPost Resultt oemGetSetupEAN8OemGetSetupEAN13 OemGetSetupIATA25 Resultt oemGetSetupIATA25OemGetSetupImager OemGetSetupInt25Prototype Resultt oemGetSetupImager Resultt oemGetSetupInt25OemGetSetupISBT OemGetSetupJapostOemGetSetupKoreanPost OemGetSetupMaxicode Resultt oemGetSetupMaxicodePCarrierMsgOnly OemGetSetupMesa Resultt oemGetSetupMesaP9MSEnabled OemGetSetupMSI Resultt oemGetSetupMSIPMinLength PMaxLength OemGetSetupMx25 OemGetSetupOCRResultt oemGetSetupMx25 Resultt oemGetSetupOCRPszGroupG PszGroupHPszCheckChar OemGetSetupPlanet OemGetSetupPlesseyResultt oemGetSetupPlanet Resultt oemGetSetupPlesseyOemGetSetupPosiCode Resultt oemGetSetupPosiCodePLimited OemGetSetupPostnet OemGetSetupQRResultt oemGetSetupPostnet Resultt oemGetSetupQROemGetSetupRSS OemGetSetupStrt25Resultt oemGetSetupRSS Resultt oemGetSetupStrt25OemGetSetupTelepen OemGetSetupTLC39Resultt oemGetSetupTelepen Resultt oemGetSetupTLC39OemGetSetupTrioptic OemGetSetupUPCAResultt oemGetSetupTrioptic Resultt oemGetSetupUPCAOemGetSetupUPCE Resultt oemGetSetupUPCEPE0Enabled PE1EnabledOemGetVideoReverse PbExpandVersionEOemImageStreamInit OemImageStreamStartOemImageStreamRead OemPowerOffImager OemImageStreamStopOemLeaveLightsOn OemLightsOnResultt oemPowerOffImager OemSetDecodeAttemptLimitOemSetDecodeCenteringWindow Resultt oemSetDecodeAttemptLimitOemSetExposureSettings OemSetDecodeModeOemSetExposureMode OemSetPrintWeight OemSetLinearRangeOemSetScanningLightsMode Resultt oemSetLinearRangeOemSetupAztec OemSetupChinaPostOemSetSearchTimeLimit OemSetupCodabar OemSetupCodablockResultt oemSetupCodabar Resultt oemSetupCodablockOemSetupCode11 OemSetupCode128Resultt oemSetupCode11 Resultt oemSetupCode128OemSetupCode16K OemSetupCode39Resultt oemSetupCode16K Resultt oemSetupCode39OemSetupCode49 Resultt oemSetupCode49BFullAscii BAppendOemSetupCode93 OemSetupCompositeOemSetupCompositeEx OemSetupDataMatrix OemSetupEAN8Resultt oemSetupDataMatrix Resultt oemSetupEAN8OemSetupEAN13 Resultt oemSetupEAN13BAddendaReq OemSetupIATA25 OemSetupInt25Resultt oemSetupIATA25 Resultt oemSetupInt25OemSetupKoreanPost OemSetupMaxicodeResultt oemSetupKoreanPost Resultt oemSetupMaxicodeOemSetupMesa Resultt oemSetupMesaOemSetupMSI OemSetupMx25Resultt oemSetupMSI Resultt oemSetupMx25OemSetupOCR Resultt oemSetupOCRNFont PszTemplateOemSetupPlanet OemSetupPlesseyResultt oemSetupPlanet Resultt oemSetupPlesseyOemSetupPosiCode OemSetupPostnetOemSetupQR OemSetupRSS OemSetupStrt25Resultt oemSetupRSS Resultt oemSetupStrt25OemSetupTelepen OemSetupUPCAResultt oemSetupTelepen Resultt oemSetupUPCAOemSetupUPCE Resultt oemSetupUPCEBXmitNumSys BEnabled OemSetVideoReverseOemStartIntellImgXfer BExpandVersionEResultt oemStartIntellImgXfer OemWaitForDecode Resultt oemWaitForDecodeOemWaitForDecodeRaw Resultt oemWaitForDecodeRawOemWaitMultipleDecode Resultt oemWaitMultipleDecodeOemWaitMultipleDecodeRaw FpMultiReadCallBackFpContinueCallBack 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