MQDistributionListItem class

This class encapsulates the MQOR, MQRR, and MQPMR structures and associates them with an owning distribution list.

Properties:

Methods:

Creation:

Use the AddDistributionListItem Method of the MQDistributionList class

AccountingToken property

Read-write. The AccountingToken to be included in the MQPMR of a message when put on a queue. Its initial value is all nulls.

Defined in:
MQDistributionListItem class

Data Type:
String of 32 characters

Syntax:
To get: accountingtoken$ = MQDistributionListItem.AccountingToken

To set: MQDistributionListItem.AccountingToken = accountingtoken$

AccountingTokenHex property

Read-write. The AccountingToken to be included in the MQPMR of a message when put on a queue.

Every two characters of the string represent the hexadecimal equivalent of a single ASCII character. For example, the pair of characters "6" and "1" represent the single character "A", the pair of characters "6" and "2" represent the single character "B" and so on.

You must supply 64 valid hexadecimal characters.

Its initial value is "0...0".

Defined in:
MQDistributionListItem class

Data Type:
String of 64 hexadecimal characters reqpresenting 32 ASCII characters.

Syntax:
To get: accountingtokenh$ = MQDistributionListItem.AccountingTokenHex

To set: MQDistributionListItem.AccountingTokenHex = accountingtokenh$

CompletionCode property

Read-only. The completion code set by the last open or put request issued against the owning distribution list object.

Defined in:
MQDistributionListItem class

Data Type:
Long

Values:

Syntax:
To get: completioncode$ = MQDistributionListItem.CompletionCode

CorrelationId property

Read-write. The CorrelId to be included in the MQPMR of a message when put on a queue. Its initial value is all nulls.

Defined in:
MQDistributionListItem class

Data Type:
String of 24 characters

Syntax:
To get: correlid$ = MQDistributionListItem.CorrelationId

To set: MQDistributionListItem.CorrelationId = correlid$

CorrelationIdHex property

Read-write. The CorrelId to be included in the MQPMR of a message when put on a queue.

Every two characters of the string represent the hexadecimal equivalent of a single ASCII character. For example, the pair of characters "6" and "1" represent the single character "A", the pair of characters "6" and "2" represent the single character "B" and so on.

You must supply 48 valid hexadecimal characters.

Its initial value is "0..0".

Defined in:
MQDistributionListItem class

Data Type:
String of 48 hexadecimal characters representing 24 ASCII characters.

Syntax:
To get: correlidh$ = MQDistributionListItem.CorrelationIdHex

To set: MQDistributionListItem.CorrelationIdHex = correlidh$

DistributionList property

Read-only. The distribution list with which this distribution list item is associated.

Defined in:
MQDistributionListItem class

Data Type:
MQDistributionList

Syntax:
To get: set distributionlist = MQDistributionListItem.DistributionList

Feedback property

Read-write. The Feedback value to be included in the MQPMR of a message when put on a queue.

Defined in:
MQDistributionListItem class

Data Type:
Long

Values:
See the WebSphere MQ Application Programming Reference

Syntax:
To get: feedback& = MQDistributionListItem.Feedback

To set: MQDistributionListItem.Feedback = feedback&

GroupId property

Read-write. The GroupId to be included in the MQPMR of a message when put on a queue. Its initial value is all nulls.

Defined in:
MQDistributionListItem class

Data Type:
String of 24 characters

Syntax:
To get: groupid$ = MQDistributionListItem.GroupId

To set: MQDistributionListItem.GroupId = groupid$

GroupIdHex property

Read-write. The GroupId to be included in the MQPMR of a message when put on a queue.

Every two characters of the string represent the hexadecimal equivalent of a single ASCII character. For example, the pair of characters "6" and "1" represent the single character "A", the pair of characters "6" and "2" represent the single character "B" and so on.

You must supply 48 valid hexadecimal characters.

Its initial value is "0..0".

Defined in:
MQDistributionListItem class

Data Type:
String of 48 hexadecimal characters reqpresenting 24 ASCII characters.

Syntax:
To get: groupidh$ = MQDistributionListItem.GroupIdHex

To set: MQDistributionListItem.GroupIdHex = groupidh$

MessageId property

Read-write. The MessageId to be included in the MQPMR of a message when put on a queue. Its initial value is all nulls.

Defined in:
MQDistributionListItem class

Data Type:
String of 24 characters

Syntax:
To get: messageid$ = MQDistributionListItem.MessageId

To set: MQDistributionListItem.MessageId = messageid$

MessageIdHex property

Read-write. The MessageId to be included in the MQPMR of a message when put on a queue.

Every two characters of the string represent the hexadecimal equivalent of a single ASCII character. For example, the pair of characters "6" and "1" represent the single character "A", the pair of characters "6" and "2" represent the single character "B" and so on.

You must supply 48 valid hexadecimal characters.

Its initial value is "0..0".

Defined in:
MQDistributionListItem class

Data Type:
String of 48 hexadecimal characters representing 24 ASCII characters.

Syntax:
To get: messageidh$ = MQDistributionListItem.MessageIdHex

To set: MQDistributionListItem.MessageIdHex = messageidh$

NextDistributionListItem property

Read-only. The next distribution list item object associated with the same distribution list.

Defined in:
MQDistributionListItem class

Data Type:
MQDistributionListItem

Syntax:
To get: set distributionlistitem = MQDistributionListItem.NextDistributionListItem

PreviousDistributionListItem property

Read-only. The previous distribution list item object associated with the same distribution list.

Defined in:
MQDistributionListItem class

Data Type:
MQDistributionListItem

Syntax:
To get: set distributionlistitem = MQDistributionListItem.PreviousDistributionListItem

QueueManagerName property

Read-write. The WebSphere MQ queue manager name.

Defined in:
MQDistributionListItem class

Data Type:
String of 48 characters.

Syntax:
To get: qmname$ = MQDistributionListItem.QueueManagerName

To set: MQDistributionListItem.QueueManagerName = qmname$

QueueName property

Read-write. The WebSphere MQ queue name.

Defined in:
MQDistributionListItem class

Data Type:
String of 48 characters.

Syntax:
To get: qname$ = MQDistributionListItem.QueueName

To set: MQDistributionListItem.QueueName = qname$

ReasonCode property

Read-only. The completion code set by the last open or put issued to the owning distribution list object.

Defined in:
MQDistributionListItem class

Data Type:
Long

Values:
See the WebSphere MQ Application Programming Reference

Syntax:
To get: reasoncode& = MQDistributionListItem.ReasonCode

ReasonName property

Read-only. The symbolic name for the ReasonCode. For example "MQRC_QMGR_NOT_AVAILABLE".

Defined in:
MQDistributionListItem class

Data Type:
String

Values:
See the WebSphere MQ Application Programming Reference

Syntax:
To get: reasonname$ = MQDistributionListItem.ReasonName

ClearErrorCodes method

Resets the CompletionCode to MQCC_OK and the ReasonCode to MQRC_NONE for both the MQDistributionListItem class and the MQSession class.

Defined in:
MQDistributionListItem class

Syntax:
Call MQDistributionListItem.ClearErrorCodes



© IBM Corporation 2002. All Rights Reserved