Hand Held Products 4X00 - Manual (Page 84)

2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide
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.