cwbDQ_GetDataAddr

Purpose

Get the address of the location of the data buffer.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetDataAddr(
                             cwbDQ_Data          data,
                             unsigned char     **dataBuffer);

Parameters

cwbDQ_Data data - input

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

unsigned char * * data - output

Pointer to where the buffer address 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.

CWBDQ_ADDRESS_NOT_SET

Address not set with cwbDQ_SetDataAddr.

Usage

Use this function to retrieve the address of the location where the data is stored. The data address must be set with the cwbDQ_SetDataAddr API, otherwise, the return code CWBDQ_ADDRESS_NOT_SET will be returned.