cwbDQ_GetSearchOrder

Purpose

Get the search order of the open attributes. The search order is used when reading or peeking a keyed data queue to identify the relationship between the key of the record to retrieve and the key value specified on the cwbDQ_SetKey API. If the data queue order attribute is not CWBDQ_SEQ_KEYED, this property is ignored.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetSearchOrder(
                             cwbDQ_Data          data,
                             unsigned short     *searchOrder);

Parameters

cwbDQ_Data data - input

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

unsigned short * searchOrder - output

Pointer to an unsigned short where the order will be written. Possible values are:

• CWBDQ_NONE
• CWBDQ_EQUAL
• CWBDQ_NOT_EQUAL
• CWBDQ_GT_OR_EQUAL
• CWBDQ_GREATER
• CWBDQ_LT_OR_EQUAL
• CWBDQ_LESS

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