cwbDQ_GetRetKey

Purpose

Get the returned key of the data object. This is the key that is associated with the messages that are retrieved from a keyed data queue. If the search order is a value other than CWBDQ_EQUAL, this key may be different than the key that is used to retrieve the message.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetRetKey(
                             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 * retKey - output

Pointer to the returned 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