cwbDQ_GetQueueAttr

Use the cwbDQ_GetQueueAttr command.

Purpose

Retrieve the attributes of the IBM i data queue object that is identified by the specified handle. A handle to the data queue attributes will be returned. The attributes then can be retrieved individually.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetQueueAttr(
                             cwbDQ_QueueHandle   queueHandle,
                             cwbDQ_Attr          queueAttributes,
                             cwbSV_ErrHandle     errorHandle);

Parameters

cwbDQ_QueueHandle queueHandle - input: Handle that was returned by a previous call to the cwbDQ_Open function. This identifies the IBM i data queue object.
cwbDQ_Attr queueAttributes - input/output: The attribute object. This was the output from the cwbDQ_CreateAttr call. The attributes will be filled in by this function, and you should call the cwbDQ_DeleteAttr function to delete this object when you have retrieved the attributes from it.
cwbSV_ErrHandle errorHandle - output: Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle API. The messages may be retrieved through the cwbSV_GetErrText API. If the parameter is set to zero, no messages will be retrieved.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWBDQ_INVALID_QUEUE_HANDLE: Invalid queue handle.
CWBDQ_REJECTED_USER_EXIT: Command rejected by user exit program.

Usage

This function requires that you have previously issued the following APIs:

cwbDQ_Open or cwbDQ_OpenEx
cwbDQ_CreateAttr