Hand Held Products 4X00 Software Manual

Also see for 4X00: User guide

Contents

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

2 - 68 IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s GuideParametersdwTimeoutTime in milliseconds that the engine scans until finding a decode. The timeout value must be greater than zero.pchMessageUpon successful return, this variable points to the decoded message. The caller should allocate enough memory forthis buffer to hold the largest possible decode message. See oemGetMaxMessageChars (page 2-12).pchCodeIDUpon successful return, this variable points to the Hand Held Products Code ID for the decoded symbology. SeeSymbology Identifiers (page 3-1).pchAIMIDUpon successful return, this variable points to the AIM ID for the decoded symbology. See Symbology Identifiers (page3-1).pchSymModifierUpon successful return, this variable points to the code modifier for the decoded symbology. See Symbology Identifiers(page 3-1).pnLengthUpon successful return, this variable points to the length of the bar code data that was captured. The length isrepresented in terms of the number of TCHAR characters in the TCHAR *pchMessage.fpCallBackPass in this pointer to a parameterless BOOL-returning function to allow for an external event that causes a return fromoemWaitForDecode. As long as the function pointed to by fpCallBack returns TRUE, oemWaitForDecode continues toattempt to decode a symbol. If the function pointed to by fpCallBack returns FALSE, then oemWaitForDecode returnswith a Result_t of RESULT_ERR_NOTRIGGER. OemWaitForDecode also returns if it gets a valid decode or thedwTimeout occurs. Setting the parameter to NULL prevents the API from calling this callback function. In that case,oemWaitForDecode only returns after a valid decode of dwTimeout has passed without a successful decode.oemWaitForDecodeRawThis function causes the engine to start scanning for a decodable symbol. This function does not return until either a symbol isdecoded, or the timeout period has elapsed. If a message was decoded, it is returned in this function's parameters in raw formas byte values.Result_t oemWaitForDecodeRaw (DWORD dwTimeout,BYTE *pchMessage,BYTE *pchCodeID,BYTE *pchAIMID,BYTE *pchSymModifier,WORD *pnLength,BOOL (*fpCallBack) (void))Return ValuesRESULT_SUCCESSRESULT_ERR_ENGINEBUSYRESULT_ERR_PARAMETERRESULT_ERR_NOTRIGGERRESULT_ERR_NODECODERESULT_ERR_NOIMAGE