Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQeQueueParms Struct Reference

Configuration Structure for processing a Queue. More...


Data Fields

MQEVERSION version
MQEINT32 opFlags
MQeStringHndl hDescription
MQeStringHndl hFileDesc
MQeVectorHndl hQAliasNameList
MQEINT64 queueExpiry
MQEINT64 queueCreationDate
MQEINT32 queueMaxMsgSize
MQEINT32 queueMaxQSize
MQEINT32 queueCurrentSize
MQEBOOL queueActive
MQEBYTE queuePriority


Detailed Description

A structure which contains the information that is required to administer a Queue. These are the features which are common to all queues.

The same structure is used to creation/inquire/update. Some elements are not permitted for some operations.


Field Documentation

MQEVERSION MQeQueueParms::version
 

version of this structure

MQEINT32 MQeQueueParms::opFlags
 

Flags to indicate what parts of this structure have been set/requested

MQeStringHndl MQeQueueParms::hDescription
 

Description of the queue (Read/Write)

MQeStringHndl MQeQueueParms::hFileDesc
 

File Description for the Message Store (Read/Create/Write)

MQeVectorHndl MQeQueueParms::hQAliasNameList
 

Alias List (Read Only)

MQEINT64 MQeQueueParms::queueExpiry
 

Default Queue Expiry (Read/Write)

MQEINT64 MQeQueueParms::queueCreationDate
 

Queue Creation Date (Read Only)

MQEINT32 MQeQueueParms::queueMaxMsgSize
 

Queue Max Message Size. (Read/Write)

Warning:
Note that the size in bytes of a message passed to mqeQueueManager_putMessage() will vary due to system-added header information such as message state or routing information. It will also be affected by user-specified conditions such as compression or encryption.

MQEINT32 MQeQueueParms::queueMaxQSize
 

Maximum Number of messages on the queue (Read/Write)

MQEINT32 MQeQueueParms::queueCurrentSize
 

Current size of the Queue (all msg states) (Read)

MQEBOOL MQeQueueParms::queueActive
 

Indication of the Queue's state (Read Only)

MQEBYTE MQeQueueParms::queuePriority
 

Priority of messages on the queue, that don't have a set priority (Read/Write)


The documentation for this struct was generated from the following file:
Generated Mon Apr 14 10:18:24 2003 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference