This class encapsulates a collection of queues - local, remote, or alias for output.
new creates a new MQDistributionList object.
Alternatively, use the AddDistributionList method of the MQQueueManager class.
Dim distlist.As New
MQDistributionList
or
Set distlist = New MQDistributionList
Read-write. The alternate user ID used to validate access to the list of queues when they are opened.
Syntax:
To get: altuser$ =
MQDistributionList.AlternateUserId
To set: MQDistributionList.AlternateUserId = altuser$
Read-write. Options used to control what happens when the distribution list is closed. The initial value is MQCO_NONE.
Syntax:
To get: closeopt& =
MQDistributionList.CloseOptions
To set: MQDistributionList.CloseOptions = closeopt&
Read-only. The completion code set by the last method or property access issued against the object.
Syntax:
To get: completioncode& =
MQDistributionList.CompletionCode
Read-write. The queue manager to which the distribution list belongs.
Syntax:
To get: set queuemanager =
MQDistributionList.ConnectionReference
To set: set MQDistributionList. ConnectionReference = queuemanager
Read-only. The first distribution list item object associated with the distribution list.
Syntax:
To get: set distributionlistitem =
MQDistributionList.FirstDistributionListItem
Read-only. A value that indicates whether or not the distribution list is currently open.
Syntax:
To get: IsOpen = MQDistributionList.IsOpen
Read-write. Options to be used when the distribution list is opened.
Syntax:
To get: openopt& =
MQDistributionList.OpenOptions
To set: MQDistributionList.OpenOptions = openopt&
Read-only. The reason code set by the last method or property access issued against the object.
Syntax:
To get: reasoncode& =
MQDistributionList.ReasonCode
Read-only. The symbolic name for the ReasonCode. For example "MQRC_QMGR_NOT_AVAILABLE".
Syntax:
To get: reasonname$ =
MQDistributionList.ReasonName
Creates a new MQDistributionListItem object and associates it with the distribution list object. The queue name parameter is mandatory.
The DistributionList property of the distribution list item is set to the owning distribution list and the FirstDistributionListItem property of the distribution list is set to reference this new distribution list item.
For the new distribution list item, the PreviousDistributionListItem property is set to nothing and the NextDistributionListItem property is set to reference any distribution list item that was previously first, or nothing if there was none previously (that is, the new one is inserted in front of those that exist already).
This will return an error if the distribution list is open.
Syntax:
set distributionlistitem =
MQDistributionList.AddDistributionListItem
(QName$, QMgrName$)
QName$ String. Name of the WebSphere MQ queue.
QMgrName$ String. Name of the WebSphere MQ queue manager.
Resets the CompletionCode to MQCC_OK and the ReasonCode to MQRC_NONE for both the MQDistributionList class and the MQSession class.
Syntax:
Call MQDistributionList.ClearErrorCodes()
Closes a distribution list using the current value of Close options.
Syntax:
Call MQDistributionList.Close()
Opens each of the queues specified by the QueueName and (where appropriate) QueueManagerName properties of the distribution list items associated with the current object using the current value of AlternateUserId.
Syntax:
Call MQDistributionList.Open()
Places a message on each of the queues identified by the distribution list items associated with the distribution list.
This method takes an MQMessage object as a parameter. The following distribution list item properties may be altered as a result of this method:
MQDistributionList class
Call MQDistributionList.Put(Message, PutMsgOptions&)
Message MQMessage object representing the message to be put.
PutMsgOptions MQPutMessageOptions object containing options to control the put operation. If not specified, default PutMessageOptions are used.