cwbDQ_GetKey

Purpose

Get the key attribute of the data object, previously set by the cwbDQ_SetKey API. This is the key that is used for writing data to a keyed data queue. Along with the search order, this key is also used to read data from a keyed data queue. The key that is associated with the record retrieved can be obtained by calling the cwbDQ_GetRetKey API.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetKey(
                             cwbDQ_Data          data,
                             unsigned char      *key);

Parameters

cwbDQ_Data data - input

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

unsigned char * key - output

Pointer to the key. The key may contain embedded NULLS, so it is not an ASCIIZ string.

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