cwbDQ_GetKeyLen

Purpose

Get the key length attribute of the data object.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetKeyLen(
                             cwbDQ_Data          data,
                             unsigned short     *keyLength);

Parameters

cwbDQ_Data data - input

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

unsigned short * keyLength - 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