cwbDQ_GetRetKeyLen

Purpose

Get the returned key length attribute of the data object. This is the length of the key that is returned by the cwbDQ_GetKey API.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetRetKeyLen(
                             cwbDQ_Data          data,
                             unsigned short     *retKeyLength);

Parameters

cwbDQ_Data data - input

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

unsigned short * retKeyLength - output

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