Hand Held Products 4X00 manual OemWaitMultipleDecode, Resultt oemWaitMultipleDecode

Page 83

Parameters

dwTimeout

Time in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero.

pchMessage

Upon successful return, this variable points to the decoded message. The caller should allocate enough memory for this buffer to hold the largest possible decode message. See oemGetMaxMessageChars (page 2-12).

pchCodeID

Upon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. See Symbology Identifiers (page 3-1).

pchAIMID

Upon successful return, this variable points to the AIM ID for the decoded symbology. See Symbology Identifiers (page 3-1).

pchSymModifier

Upon successful return, this variable points to the code modifier for the decoded symbology. See Symbology Identifiers (page 3-1).

pnLength

Upon successful return, this variable points to the length of the bar code data that was captured. The length is represented in terms of the number of BYTE characters in the BYTE *pchMessage.

fpCallBack

Pass in this pointer to a parameterless 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 valid decode or the dwTimeout occurs. Setting the parameter to NULL prevents the API from calling this callback function. In that case, oemWaitForDecodeRaw only returns after a valid decode of dwTimeout has passed without a successful decode.

oemWaitMultipleDecode

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

DWORD dwTimeout,

BOOL (*pMultiReadCallBack)(DecodeMsg_t *), BOOL (*pKeepGoingCallBack)(void)

)

Return Values

RESULT_SUCCESS

RESULT_ERR_UNSUPPORTED

RESULT_ERR_PARAMETER

RESULT_ERR_NOTRIGGER

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

2 - 69

Image 83
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 OemAimerOn OemAcquireImageOemConnect OemDefaultSymbologyOemDisableSymbology OemDisconnect OemDisableSymbologyAllOemEnableSymbology OemEnableSymbologyAllOemGetDecodeCenteringWindow OemGetAPIRevisionOemGetDecodeAttemptLimit OemGetDecodeTime OemGetDecodeModeOemGetDecoderRevision Resultt oemGetExposureSettings OemGetErrorMessageOemGetExposureSettings Resultt oemGetErrorMessageResultt oemGetImage OemGetImageResultt oemGetImagerInfo OemGetImageDataOemGetImagerInfo Prototype Resultt oemGetImageDataPImgProp OemGetImagerPropertiesPnCols Resultt oemGetImagerPropertiesResultt oemGetLastImageExt OemGetLastImageOemGetLastImageExt Resultt oemGetLastImageResultt oemGetLeaveLightsOn OemGetLastImageSizeOemGetLeaveLightsOn Resultt oemGetLastImageSizeOemGetMaxMessageChars OemGetPrintWeightOemGetLinearRange OemGetSearchTimeLimit OemGetSetupAllOemGetScanDriverRevision OemGetSetupBPO OemGetSetupAusPostOemGetSetupAztec Resultt oemGetSetupChinaPost OemGetSetupCanPostOemGetSetupChinaPost Resultt oemGetSetupCanPostResultt oemGetSetupCodablock OemGetSetupCodabarOemGetSetupCodablock Resultt oemGetSetupCodabarResultt oemGetSetupCode11 OemGetSetupCode11Resultt oemGetSetupCode16K OemGetSetupCode128OemGetSetupCode16K Resultt oemGetSetupCode128Resultt oemGetSetupCode39 OemGetSetupCode32OemGetSetupCode39 Resultt oemGetSetupCode32PbAppend OemGetSetupCode49Resultt oemGetSetupCode49 PbFullAsciiResultt oemGetSetupComposite OemGetSetupCode93OemGetSetupComposite Resultt oemGetSetupCode93PbCompositeOnUpcEan OemGetSetupCompositeExResultt oemGetSetupCompositeEx Resultt oemGetSetupDataMatrix OemGetSetupCouponCodeOemGetSetupDataMatrix Resultt oemGetSetupCouponCodeResultt oemGetSetupEAN8 OemGetSetupDutchPostOemGetSetupEAN8 Resultt oemGetSetupDutchPostOemGetSetupEAN13 Resultt oemGetSetupIATA25 OemGetSetupIATA25Resultt oemGetSetupInt25 OemGetSetupImagerOemGetSetupInt25 Prototype Resultt oemGetSetupImagerOemGetSetupKoreanPost OemGetSetupISBTOemGetSetupJapost PCarrierMsgOnly OemGetSetupMaxicodeResultt oemGetSetupMaxicode P9MSEnabled OemGetSetupMesaResultt oemGetSetupMesa PMinLength PMaxLength OemGetSetupMSIResultt oemGetSetupMSI Resultt oemGetSetupOCR OemGetSetupMx25OemGetSetupOCR Resultt oemGetSetupMx25PszCheckChar PszGroupGPszGroupH Resultt oemGetSetupPlessey OemGetSetupPlanetOemGetSetupPlessey Resultt oemGetSetupPlanetPLimited OemGetSetupPosiCodeResultt oemGetSetupPosiCode Resultt oemGetSetupQR OemGetSetupPostnetOemGetSetupQR Resultt oemGetSetupPostnetResultt oemGetSetupStrt25 OemGetSetupRSSOemGetSetupStrt25 Resultt oemGetSetupRSSResultt oemGetSetupTLC39 OemGetSetupTelepenOemGetSetupTLC39 Resultt oemGetSetupTelepenResultt oemGetSetupUPCA OemGetSetupTriopticOemGetSetupUPCA Resultt oemGetSetupTriopticResultt oemGetSetupUPCE OemGetSetupUPCEPbExpandVersionE PE0EnabledPE1Enabled OemGetVideoReverseOemImageStreamRead OemImageStreamInitOemImageStreamStart OemLightsOn OemPowerOffImagerOemImageStreamStop OemLeaveLightsOnResultt oemSetDecodeAttemptLimit Resultt oemPowerOffImagerOemSetDecodeAttemptLimit OemSetDecodeCenteringWindowOemSetExposureMode OemSetExposureSettingsOemSetDecodeMode Resultt oemSetLinearRange OemSetPrintWeightOemSetLinearRange OemSetScanningLightsModeOemSetSearchTimeLimit OemSetupAztecOemSetupChinaPost Resultt oemSetupCodablock OemSetupCodabarOemSetupCodablock Resultt oemSetupCodabarResultt oemSetupCode128 OemSetupCode11OemSetupCode128 Resultt oemSetupCode11Resultt oemSetupCode39 OemSetupCode16KOemSetupCode39 Resultt oemSetupCode16KBAppend OemSetupCode49Resultt oemSetupCode49 BFullAsciiOemSetupCompositeEx OemSetupCode93OemSetupComposite Resultt oemSetupEAN8 OemSetupDataMatrixOemSetupEAN8 Resultt oemSetupDataMatrixBAddendaReq OemSetupEAN13Resultt oemSetupEAN13 Resultt oemSetupInt25 OemSetupIATA25OemSetupInt25 Resultt oemSetupIATA25Resultt oemSetupMaxicode OemSetupKoreanPostOemSetupMaxicode Resultt oemSetupKoreanPostResultt oemSetupMesa OemSetupMesaResultt oemSetupMx25 OemSetupMSIOemSetupMx25 Resultt oemSetupMSIPszTemplate OemSetupOCRResultt oemSetupOCR NFontResultt oemSetupPlessey OemSetupPlanetOemSetupPlessey Resultt oemSetupPlanetOemSetupQR OemSetupPosiCodeOemSetupPostnet Resultt oemSetupStrt25 OemSetupRSSOemSetupStrt25 Resultt oemSetupRSSResultt oemSetupUPCA OemSetupTelepenOemSetupUPCA Resultt oemSetupTelepenBXmitNumSys OemSetupUPCEResultt oemSetupUPCE BExpandVersionE BEnabledOemSetVideoReverse OemStartIntellImgXfer Resultt oemStartIntellImgXfer Resultt oemWaitForDecode OemWaitForDecodeResultt oemWaitForDecodeRaw OemWaitForDecodeRawResultt oemWaitMultipleDecode OemWaitMultipleDecodeResultt oemWaitMultipleDecodeRaw OemWaitMultipleDecodeRawFpMultiReadCallBack FpContinueCallBackSymbology Identifiers Function Result Values Mail aptechsupport@handheld.com Mail latechsupport@handheld.comMail eutechsupport@handheld.com Imageteam 4X00 Series Software Development Kit SDK Page Hand Held Products, Inc