cwbDQ_SetDesc

Purpose

Set the attribute for the description of the data queue.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_SetDesc(
                             cwbDQ_Attr          queueAttributes,
                             char               *description);

Parameters

cwbDQ_Attr queueAttributes - input

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

char * description - input

Pointer to an ASCIIZ string that contains the description for the data queue. The maximum length for the description is 50 characters.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_POINTER

Bad or null pointer.

CWBDQ_INVALID_ATTRIBUTE_HANDLE

Invalid attributes handle.

CWBDQ_INVALID_QUEUE_TITLE

Queue title is too long.

Usage

None