MQPutMessageOptions class

This class encapsulates the various options that control the action of putting a message onto an WebSphere MQ Queue.

Containment

Contained by the MQSession class.

Creation

New creates a new MQPutMessageOptions object and sets all its properties to initial values.

Alternatively, use the AccessPutMessageOptions method of the MQSession class.

Syntax:

Dim pmo As New MQPutMessageOptions or

Set pmo = New MQPutMessageOptions

Properties

• CompletionCode property
• Options property
• ReasonCode property
• ReasonName property
• RecordFields property
• ResolvedQueueManagerName property
• ResolvedQueueName property

Methods

• ClearErrorCodes method

CompletionCode property

Read-only. Returns the completion code set by the last method or property access issued against the object.

Defined in: MQPutMessageOptions class

Data Type: Long

Values:

• MQCC_OK
• MQCC_WARNING
• MQCC_FAILED

Syntax:
To get: completioncode& = PutOpts.CompletionCode

Options property

Read-write. The MQPMO Options field. See the WebSphere MQ Application Programming Reference for details. Initial value is MQPMO_NONE.

Defined in: MQPutMessageOptions Class.

Data Type: Long

Syntax:
To get: options& = PutOpts.Options

To set: PutOpts.Options = options&

The MQPMO_PASS_IDENTITY_CONTEXT and MQPMO_PASS_ALL_CONTEXT options are not supported.

ReasonCode property

Read-only. Returns the reason code set by the last method or property access issued against the object.

Defined in: MQPutMessageOptions class

Data Type: Long

Values:

• See the WebSphere MQ Application Programming Reference

Syntax:
To get: reasoncode& = PutOpts.ReasonCode

ReasonName property

Read-only. Returns the symbolic name of the latest reason code. For example, "MQRC_QMGR_NOT_AVAILABLE".

Defined in: MQPutMessageOptions class

Data Type: String

Values:

• See the WebSphere MQ Application Programming Reference

Syntax:
To get: reasonname$ = PutOpts.ReasonName

RecordFields property

Read-write. Flags indicating which fields are to be customized on a per-queue basis when putting a message to a distribution list. The initial value is zero.

This property corresponds to the PutMsgRecFields flags in the MQI MQPMO structure. In the MQI, these flags control which fields (in the MQPMR structure) are present and used by the MQPUT. In an MQPutMessageOptions object these fields are always present and the flags therefore only affect which fields are used by the Put. See the WebSphere MQ Application Programming Reference for further details.

Defined in:

MQPutMessageOptions class

Data Type:

Long

Syntax:
To get: recordfields& = PutOpts.RecordFields

To set: PutOpts.RecordFields = recordfields&

ResolvedQueueManagerName property

Read-only. The MQPMO ResolvedQMgrName field. See the WebSphere MQ Application Programming Reference for details. The initial value is all blanks.

Defined in: MQPutMessageOptions class

Data Type: String of 48 characters

Syntax:
To get: qmgr$ = PutOpts.ResolvedQueueManagerName

ResolvedQueueName property

Read-only. The MQPMO ResolvedQName field. See the WebSphere MQ Application Programming Reference for details. The initial value is all blanks.

Defined in: MQPutMessageOptions class

Data Type: String of 48 characters

Syntax:
To get: qname$ = PutOpts.ResolvedQueueName

ClearErrorCodes method

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

Defined in: MQPutMessageOptions class

Syntax:
Call PutOpts.ClearErrorCodes()