cwbDQ_GetRetDataLen

Use the cwbDQ_GetRetDataLen command.

Purpose

Get the length of data that was returned. The returned data length will be zero until a cwbDQ_Read or cwbDQ_Peek API is called.Then it will have the length of the data that actually was returned.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetRetDataLen(
                             cwbDQ_Data          data,
                             unsigned long      *retDataLength);

Parameters

cwbDQ_Data data - input: Handle of the data object that was returned by a previous call to cwbDQ_CreateData.
unsigned long * retDataLength - output: Pointer to an unsigned long where the length of the data returned will be written.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWB_INVALID_POINTER: Bad or null pointer.
CWBDQ_INVALID_DATA_HANDLE: Invalid data handle.

Usage

None