Hand Held Products 4X00 Software Manual

Also see for 4X00: User guide

Contents

Hand Held Products 4X00 Software Manual Manual pdf 84 page image

2 - 70 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersdwTimeoutMaximum amount of time in milliseconds that the decoder may use to attempt to find and decode symbols.fpMultiReadCallBackPointer to a callback function that takes a DecodeMsg_t variable as a parameter and returns a BOOL. Upon asuccessful decode, the decoder calls this function using the DecodeMsg_t variable to return the decode data. Thereturn parameter from this function dictates if the decoder continues to look for additional symbols. If the callbackfunction returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecode returns. If the returnparameter is TRUE, the decoder continues to attempt decoding additional symbols.fpContinueCallBackPointer to a callback function that takes no parameters and returns a BOOL. This callback function may be used toterminate 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 decoderstops decode attempts and oemWaitMultipleDecode returns. Setting this parameter to NULL causes the decoder toignore the use of this callback during execution.oemWaitMultipleDecodeRawThis function is used to read multiple symbols using a single function call. When called, this function attempts to find and decodeunique symbols once, and use the multi-read callback function to pass the decoded data back to the calling application in rawform as byte values. This function continues to find and decode symbols until the time specified in the dwTimeout parameter hasexpired, or until one of the callback functions returns false.Result_t oemWaitMultipleDecodeRaw (DWORD dwTimeout,BOOL (*pMultiReadCallBack)(DecodeMsgRaw_t *),BOOL (*pKeepGoingCallBack)(void))Return ValuesRESULT_SUCCESSRESULT_ERR_UNSUPPORTEDRESULT_ERR_PARAMETERRESULT_ERR_NOTRIGGERParametersdwTimeoutMaximum amount of time in milliseconds that the decoder may use to attempt to find and decode symbols.fpMultiReadCallBackPointer to a callback function that takes a DecodeMsgRaw_t variable as a parameter and returns a BOOL. Upon asuccessful decode, the decoder calls this function using the DecodeMsgRaw_t variable to return the decode data. Thereturn parameter from this function dictates if the decoder continues to look for additional symbols. If the callbackfunction returns FALSE, the decoder stops decode attempts and oemWaitMultipleDecodeRaw returns. If the returnparameter is TRUE, the decoder continues to attempt decoding additional symbols.fpContinueCallBackPointer to a callback function that takes no parameters and returns a BOOL. This callback function may be used toterminate 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, thedecoder stops decode attempts and oemWaitMultipleDecodeRaw returns. Setting this parameter to NULL causes thedecoder to ignore the use of this callback during execution.