cwbDQ_GetDataLen

Purpose

Get the data length attribute of the data object. This is the total length of the data object. To obtain the length of data that was read, use the cwbDQ_GetRetDataLen API.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetDataLen(
                             cwbDQ_Data          data,
                             unsigned long      *dataLength);

Parameters

cwbDQ_Data data - input

Handle of the data object that was returned by a previous call to cwbDQ_CreateData.

unsigned long * dataLength - output

Pointer to an unsigned long where the length of the data 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