Hand Held Products 4X00 manual OemWaitMultipleDecode, Resultt oemWaitMultipleDecode

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