cwbDQ_SetKeySize

Purpose

Set the attribute for the key size in bytes.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_SetKeySize(
                             cwbDQ_Attr          queueAttributes,
                             unsigned short      keySize);

Parameters

cwbDQ_Attr queueAttributes - input

Handle of the data queue attributes returned by a previous call to cwbDQ_CreateAttr.

unsigned short keySize - input

Size in bytes of the key. This value should be zero if the order is LIFO or FIFO, and between 1 and 256 for KEYED.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWBDQ_INVALID_KEY_LENGTH

Invalid key length.

CWBDQ_INVALID_ATTRIBUTE_HANDLE

Invalid attributes handle.

Usage

None