expiration report options, confirm on arrival report options, confirm on delivery report options, disposition options" /> Properties

 

Properties

AccountingToken

public String AccountingToken {get; set;}

Part of the identity context of the message; it allows an application to charge for work done as a result of the message.

The default value is MQC.MQACT_NONE.

ApplicationIdData

public String ApplicationIdData {get; set;}

Part of the identity context of the message; it is information that is defined by the application suite, and can be used to provide additional information about the message or its originator.

The default value is "".

ApplicationOriginData

public String ApplicationOriginData {get; set;}

Information defined by the application that can be used to provide additional information about the origin of the message.

The default value is "".

BackoutCount

public int BackoutCount {get;}

A count of the number of times the message has previously been returned by an MQQueue.Get() call as part of a unit of work, and subsequently backed out.

The default value is zero.

CharacterSet

public int CharacterSet {get; set;}

The coded character set identifier of character data in the application message data. The behavior of the ReadString, ReadLine, and WriteString methods is altered accordingly.

The default value for this field is MQC.MQCCSI_Q_MGR. If the default value is used, CharacterSet 1200 (Unicode) is assumed. The following table shows coded character set identifiers and the characterSet values to use:

Table 1. Character set identifiers
characterSet Description
37 ibm037
437 ibm437 / PC Original
500 ibm500
819 iso-8859-1 / latin1 / ibm819
1200 Unicode
1208 UTF-8
273 ibm273
277 ibm277
278 ibm278
280 ibm280
284 ibm284
285 ibm285
297 ibm297
420 ibm420
424 ibm424
737 ibm737 / PC Greek
775 ibm775 / PC Baltic
813 iso-8859-7 / greek / ibm813
838 ibm838
850 ibm850 / PC Latin 1
852 ibm852 / PC Latin 2
855 ibm855 / PC Cyrillic
856 ibm856
857 ibm857 / PC Turkish
860 ibm860 / PC Portuguese
861 ibm861 / PC Icelandic
862 ibm862 / PC Hebrew
863 ibm863 / PC Canadian French
864 ibm864 / PC Arabic
865 ibm865 / PC Nordic
866 ibm866 / PC Russian
868 ibm868
869 ibm869 / PC Modern Greek
870 ibm870
871 ibm871
874 ibm874
875 ibm875
912 iso-8859-2 / latin2 / ibm912
913 iso-8859-3 / latin3 / ibm913
914 iso-8859-4 / latin4 / ibm914
915 iso-8859-5 / cyrillic / ibm915
916 iso-8859-8 / hebrew / ibm916
918 ibm918
920 iso-8859-9 / latin5 / ibm920
921 ibm921
922 ibm922
930 ibm930
932 PC Japanese
933 ibm933
935 ibm935
937 ibm937
939 ibm939
942 ibm942
948 ibm948
949 ibm949
950 ibm950 / Big 5 Traditional Chinese
954 EUCJIS
964 ibm964 / CNS 11643 Traditional Chinese
970 ibm970
1006 ibm1006
1025 ibm1025
1026 ibm1026
1089 iso-8859-6 / arabic / ibm1089
1097 ibm1097
1098 ibm1098
1112 ibm1112
1122 ibm1122
1123 ibm1123
1124 ibm1124
1250 Windows Latin 2
1251 Windows Cyrillic
1252 Windows Latin 1
1253 Windows Greek
1254 Windows Turkish
1255 Windows Hebrew
1256 Windows Arabic
1257 Windows Baltic
1258 Windows Vietnamese
1381 ibm1381
1383 ibm1383
2022 JIS
5601 ksc-5601 Korean
33722 ibm33722

CorrelationId

public byte[] CorrelationId {get;set;}

For an MQQueue.Get() call, the correlation identifier of the message to be retrieved. Normally the queue manager returns the first message with a message identifier and correlation identifier that match those specified. The special value MQC.MQCI_NONE allows any correlation identifier to match.

For an MQQueue.Put() call, this specifies the correlation identifier to use.

The default value is MQC.MQCI_NONE.

DataLength

public int DataLength {get;}

The number of bytes of message data remaining to be read.

DataOffset

public int DataOffset {get; set;}

The current cursor position within the message data (the point at which read and write operations take effect).

Encoding

public int Encoding {get; set;}

The representation used for numeric values in the application message data; this applies to binary, packed decimal, and floating point data. The behavior of the read and write methods for these numeric formats is altered accordingly.

The following encodings are defined for binary integers:

MQC.MQENC_INTEGER_NORMAL

Big-endian integers.

MQC.MQENC_INTEGER_REVERSED

Little-endian integers, as used by PCs.

The following encodings are defined for packed-decimal integers:

MQC.MQENC_DECIMAL_NORMAL

Big-endian packed-decimal, as used by z/OS.

MQC.MQENC_DECIMAL_REVERSED

Little-endian packed-decimal.

The following encodings are defined for floating-point numbers:

MQC.MQENC_FLOAT_IEEE_NORMAL

Big-endian IEEE floats.

MQC.MQENC_FLOAT_IEEE_REVERSED

Little-endian IEEE floats, as used by PCs.

MQC.MQENC_FLOAT_S390

z/OS format floating points.

Construct a value for the encoding field by adding together one value from each of these three sections (or using the bitwise OR operator). The default value is:


MQC.MQENC_INTEGER_REVERSED | MQC.MQENC_DECIMAL_REVERSED | MQC.MQENC_FLOAT_IEEE_REVERSED

For convenience, this value is also represented by MQC.MQENC_NATIVE. This setting causes WriteInt() to write a

little-endian

integer, and ReadInt() to read a

little-endian

integer. If you set the flag MQC.MQENC_INTEGER_NORMAL flag instead, WriteInt() writes a big-endian integer, and ReadInt() reads a big-endian integer.

A loss in precision can occur when converting from IEEE format floating points to zSeries format floating points.

Expiry

public int Expiry {get; set;}

An expiry time expressed in tenths of a second, set by the application that puts the message. After a message's expiry time has elapsed, it is eligible to be discarded by the queue manager. If the message specified one of the MQC.MQRO_EXPIRATION flags, a report is generated when the message is discarded.

The default value is MQC.MQEI_UNLIMITED, meaning that the message never expires.

Feedback

public int Feedback {get; set;}

Used with a message of type MQC.MQMT_REPORT to indicate the nature of the report. The following feedback codes are defined by the system:

  • MQC.MQFB_EXPIRATION

  • MQC.MQFB_COA

  • MQC.MQFB_COD

  • MQC.MQFB_QUIT

  • MQC.MQFB_PAN

  • MQC.MQFB_NAN

  • MQC.MQFB_DATA_LENGTH_ZERO

  • MQC.MQFB_DATA_LENGTH_NEGATIVE

  • MQC.MQFB_DATA_LENGTH_TOO_BIG

  • MQC.MQFB_BUFFER_OVERFLOW

  • MQC.MQFB_LENGTH_OFF_BY_ONE

  • MQC.MQFB_IIH_ERROR

Application-defined feedback values in the range MQC.MQFB_APPL_FIRST to MQC.MQFB_APPL_LAST can also be used.

The default value of this field is MQC.MQFB_NONE, indicating that no feedback is provided.

Format

public String Format {get; set;}

A format name used by the sender of the message to indicate the nature of the data in the message to the receiver. We can use your own format names, but names beginning with the letters MQ have meanings that are defined by the queue manager. The queue manager built-in formats are:

MQC.MQFMT_ADMIN

Command server request/reply message.

MQC.MQFMT_COMMAND_1

Type 1 command reply message.

MQC.MQFMT_COMMAND_2

Type 2 command reply message.

MQC.MQFMT_DEAD_LETTER_HEADER

Dead-letter header.

MQC.MQFMT_EVENT

Event message.

MQC.MQFMT_NONE

No format name.

MQC.MQFMT_PCF

User-defined message in programmable command format.

MQC.MQFMT_STRING

Message consisting entirely of characters.

MQC.MQFMT_TRIGGER

Trigger message

MQC.MQFMT_XMIT_Q_HEADER

Transmission queue header.

The default value is MQC.MQFMT_NONE.

GroupId

public byte[] GroupId {get; set;}

A byte string that identifies the message group to which the physical message belongs.

The default value is MQC.MQGI_NONE.

MessageFlags

public int MessageFlags {get; set;}

Flags controlling the segmentation and status of a message.

MessageId

public byte[] MessageId {get; set;}

For an MQQueue.Get() call, this field specifies the message identifier of the message to be retrieved. Normally, the queue manager returns the first message with a message identifier and correlation identifier that match those specified. The special value MQC.MQMI_NONE allows any message identifier to match.

For an MQQueue.Put() call, this specifies the message identifier to use. If MQC.MQMI_NONE is specified, the queue manager generates a unique message identifier when the message is put. The value of this member variable is updated after the put, to indicate the message identifier that was used.

The default value is MQC.MQMI_NONE.

MessageLength

public int MessageLength {get;}

The number of bytes of message data in the MQMessage object.

MessageSequenceNumber

public int MessageSequenceNumber {get; set;}

The sequence number of a logical message within a group.

MessageType

public int MessageType {get; set;}

Indicates the type of the message. The following values are currently defined by the system:

  • MQC.MQMT_DATAGRAM

  • MQC.MQMT_REPLY

  • MQC.MQMT_REPORT

  • MQC.MQMT_REQUEST

Application-defined values can also be used, in the range MQC.MQMT_APPL_FIRST to MQC.MQMT_APPL_LAST.

The default value of this field is MQC.MQMT_DATAGRAM.

Offset

public int Offset {get;}

In a segmented message, the offset of data in a physical message from the start of a logical message.

OriginalLength

public int OriginalLength {get;}

The original length of a segmented message.

Persistence

public int Persistence {get; set;}

Message persistence. The following values are defined:

  • MQC.MQPER_NOT_PERSISTENT

  • MQC.MQPER_PERSISTENT

  • MQC.MQPER_PERSISTENCE_AS_Q_DEF

The default value is MQC.MQPER_PERSISTENCE_AS_Q_DEF, which takes the persistence for the message from the default persistence attribute of the destination queue.

Priority

public int Priority {get; set;}

The message priority. The special value MQC.MQPRI_PRIORITY_AS_Q_DEF can also be set in outbound messages, in which case the priority for the message is taken from the default priority attribute of the destination queue.

The default value is MQC.MQPRI_PRIORITY_AS_Q_DEF.

PutApplicationName

public String PutApplicationName {get; set;}

The name of the application that put the message. The default value is "".

PutApplicationType

public int PutApplicationType {get; set;}

The type of application that put the message. This can be a system-defined or user-defined value. The following values are defined by the system:

  • MQC.MQAT_AIX

  • MQC.MQAT_CICS

  • MQC.MQAT_DOS

  • MQC.MQAT_IMS

  • MQC.MQAT_MVS

  • MQC.MQAT_OS2

  • MQC.MQAT_OS400

  • MQC.MQAT_QMGR

  • MQC.MQAT_UNIX

  • MQC.MQAT_WINDOWS

  • MQC.MQAT_JAVA

The default value is the special value MQC.MQAT_NO_CONTEXT, which indicates that no context information is present in the message.

PutDateTime

public DateTime PutDateTime {get;}

The time and date that the message was put.

ReplyToQueueManagerName

public String ReplyToQueueManagerName {get; set;}

The name of the queue manager to which reply or report messages should be sent.

The default value is "".

If the value is "" on an MQQueue.put() call, the QueueManager fills in the value.

ReplyToQueueName

public String ReplyToQueueName {get; set;}

The name of the message queue to which the application that issued the get request for the message should send MQC.MQMT_REPLY and MQC.MQMT_REPORT messages.

The default value is "".

Report

public int Report {get; set;}

A report is a message about another message. This member variable enables the application sending the original message to specify which report messages are required, whether the application message data is to be included in them, and how to set the message and correlation identifiers in the report or reply. Any, all, or none of the following report types can be requested:

  • Exception

  • Expiration

  • Confirm on arrival

  • Confirm on delivery

For each type, only one of the three corresponding values below should be specified, depending on whether the application message data is to be included in the report message.

Note:
Values marked with ** in the following list are not supported by z/OS queue managers; do not use them if your application is likely to access a z/OS queue manager, regardless of the platform on which the application is running.

The valid values are:

  • MQC.MQRO_COA

  • MQC.MQRO_COA_WITH_DATA

  • MQC.MQRO_COA_WITH_FULL_DATA**

  • MQC.MQRO_COD

  • MQC.MQRO_COD_WITH_DATA

  • MQC.MQRO_COD_WITH_FULL_DATA**

  • MQC.MQRO_EXCEPTION

  • MQC.MQRO_EXCEPTION_WITH_DATA

  • MQC.MQRO_EXCEPTION_WITH_FULL_DATA**

  • MQC.MQRO_EXPIRATION

  • MQC.MQRO_EXPIRATION_WITH_DATA

  • MQC.MQRO_EXPIRATION_WITH_FULL_DATA**

We can specify one of the following to control how the message Id is generated for the report or reply message:

  • MQC.MQRO_NEW_MSG_ID

  • MQC.MQRO_PASS_MSG_ID

We can specify one of the following to control how the correlation Id of the report or reply message is to be set:

  • MQC.MQRO_COPY_MSG_ID_TO_CORREL_ID

  • MQC.MQRO_PASS_CORREL_ID

We can specify one of the following to control the disposition of the original message when it cannot be delivered to the destination queue:

  • MQC.MQRO_DEAD_LETTER_Q

  • MQC.MQRO_DISCARD_MSG **

If no report options are specified, the default is:

MQC.MQRO_NEW_MSG_ID |
MQC.MQRO_COPY_MSG_ID_TO_CORREL_ID |
MQC.MQRO_DEAD_LETTER_Q

We can specify one or both of the following to request that the receiving application sends a positive action or negative action report message.

  • MQC.MQRO_PAN

  • MQC.MQRO_NAN

TotalMessageLength

public int TotalMessageLength {get;}

The total number of bytes in the message as stored on the message queue from which this message was received.

UserId

public String UserId {get; set;}

Part of the identity context of the message; it identifies the user that originated this message.

The default value is "".

Version

public int V{get; set;}

The version of the MQMD structure in use.


csqzav0561