MQSTS - Status reporting structure

The MQSTS structure is an output parameter from the MQSTAT command. The MQSTAT command is used to retrieve status information. This information is returned in an MQSTS structure.

Character set and encoding

Character data in MQSTS is in the character set of the local queue manager; this is given by the CodedCharSetId queue manager attribute. Numeric data in MQSTS is in the native machine encoding; this is given by Encoding.

Fields

Note: In the following table, the fields are grouped by usage rather than alphabetically. The child topics follow the same sequence.

Table 1. Fields in MQSTS
Field name and description	Name of constant	Initial value (if any) of constant
StrucId (structure identifier)	MQSTS_STRUC_ID	`'STAT¬'`
Version (structure version number)	MQSTS_VERSION_1	1
CompCode (completion code of first error)	MQCC_OK	0
Reason (reason code of first error)	MQRC_NONE	0
PutSuccessCount (number of successful asynchronous put calls)	None	0
PutWarningCount (number of asynchronous put calls that had warnings)	None	0
PutFailureCount (number of failed asynchronous put calls)	None	0
ObjectType (type of failing object)	MQOT_Q	1
ObjectName (name of failing object)	None	Null string or blanks
ObjectQMgrName (name of queue manager that owns the failing object	None	Null string or blanks
ResolvedObjectName (resolved name of destination queue)	None	Null string or blanks
ResolvedQMgrName (resolved name of destination queue manager)	None	Null string or blanks
Note: The remaining fields are ignored if Version is less than MQSTS_VERSION_2.
ObjectString (long object name of failing object)	MQCHARV_DEFAULT	{NULL,0,0,0,-3}
SubName (subscription name of failing subscription)	MQCHARV_DEFAULT	{NULL,0,0,0,-3}
OpenOptions (open options associated with the failure)	None	0
SubOptions(subscription options associated with the failure)	None	0
Notes: The symbol `¬` represents a single blank character. The value Null string or blanks denotes the null string in C, and blank characters in other programming languages. In the C programming language, the macro variable MQSTS_DEFAULT contains the values that are listed in the table. It can be used in the following way to provide initial values for the fields in the structure: `MQSTS MySTS = {MQSTS_DEFAULT};`

Language declarations

C declaration for MQSTS


typedef struct tagMQSTS MQSTS;
struct tagMQSTS { 
 MQCHAR4   StrucId;            /* Structure identifier */
 MQLONG    Version;            /* Structure version number */
 MQLONG    CompCode;           /* Completion Code of first error */
 MQLONG    Reason;             /* Reason Code of first error */
 MQLONG    PutSuccessCount;    /* Number of Async calls succeeded */
 MQLONG    PutWarningCount;    /* Number of Async calls had warnings */
 MQLONG    PutFailureCount;    /* Number of Async calls had failures */
 MQLONG    ObjectType;         /* Failing object type */
 MQCHAR48  ObjectName;         /* Failing object name */
 MQCHAR48  ObjectQMgrName;     /* Failing object queue manager name */
 MQCHAR48  ResolvedObjectName; /* Resolved name of destination queue */
 MQCHAR48  ResolvedQMgrName;   /* Resolved name of destination qmgr */
/* Ver:1 */
 MQCHARV   ObjectString;       /* Failing object long name */
 MQCHARV   SubName;            /* Failing subscription name */
 MQLONG    OpenOptions;        /* Failing open options */
 MQLONG    SubOptions;         /* Failing subscription options */
/* Ver:2 */
};

COBOL declaration for MQSTS


      ** MQSTS structure
       10  MQSTS.
      ** Structure identifier
       15  MQSTS-STRUCID PIC X(4).
      ** Structure version number
       15  MQSTS-VERSION PIC S9(9) BINARY.
      ** Completion Code of first error
       15  MQSTS-COMPCODE PIC S9(9) BINARY.
      ** Reason Code of first error
       15  MQSTS-REASON PIC S9(9) BINARY.
      ** Number of Async put calls succeeded
       15  MQSTS-PUTSUCCESSCOUNT PIC S9(9) BINARY.
      ** Number of Async put calls had warnings
       15  MQSTS-PUTWARNINGCOUNT PIC S9(9) BINARY.
      ** Number of Async put calls had failures
       15  MQSTS-PUTFAILURECOUNT PIC S9(9) BINARY.
      ** Failing object type
       15  MQSTS-OBJECTTYPE PIC S9(9) BINARY.
      ** Failing object name
       15  MQSTS-OBJECTNAME PIC X(48).
      ** Failing object queue manager
       15  MQSTS-OBJECTQMGRNAME PIC X(48).
      ** Resolved name of destination queue
       15  MQSTS-RESOLVEDOBJECTNAME PIC X(48).
      ** Resolved name of destination qmgr
       15  MQSTS-RESOLVEDQMGRNAME PIC X(48).
      ** Ver:1 **
      ** Failing object long name
       15  MQSTS-OBJECTSTRING.
      ** Address of variable length string
       20  MQSTS-OBJECTSTRING-VSPTR POINTER.
      ** Offset of variable length string
       20  MQSTS-OBJECTSTRING-VSOFFSET PIC S9(9) BINARY.
      ** Size of buffer
       20  MQSTS-OBJECTSTRING-VSBUFSIZE PIC S9(9) BINARY.
      ** Length of variable length string
       20  MQSTS-OBJECTSTRING-VSLENGTH PIC S9(9) BINARY.
      ** CCSID of variable length string
       20  MQSTS-OBJECTSTRING-VSCCSID PIC S9(9) BINARY.
      ** Failing subscription name
       15  MQSTS-SUBNAME.
      ** Address of variable length string
       20  MQSTS-SUBNAME-VSPTR POINTER.
      ** Offset of variable length string
       20  MQSTS-SUBNAME-VSOFFSET PIC S9(9) BINARY.
      ** Size of buffer
       20  MQSTS-SUBNAME-VSBUFSIZE PIC S9(9) BINARY.
      ** Length of variable length string
       20  MQSTS-SUBNAME-VSLENGTH PIC S9(9) BINARY.
      ** CCSID of variable length string
       20  MQSTS-SUBNAME-VSCCSID PIC S9(9) BINARY.
      ** Failing open options
       15  MQSTS-OPENOPTIONS PIC S9(9) BINARY.
      ** Failing subscription options
       15  MQSTS-SUBOPTIONS PIC S9(9) BINARY.
      ** Ver:2 **

PL/I declaration for MQSTS


dcl
   1 MQSTS based,
     3 StrucId             char(4),       /* Structure identifier */
      3 Version            fixed bin(31), /* Structure version number */
      3 CompCode           fixed bin(31), /* Completion code */
      3 Reason             fixed bin(31), /* Reason code */
      3 PutSuccessCount    fixed bin(31), /* Put success count */
      3 PutWarningCount    fixed bin(31), /* Put warning count */
      3 PutFailureCount    fixed bin(31), /* Put failure count */
      3 ObjectType         fixed bin(31), /* Object type */
      3 ObjectName         char(48), /* Object name */
      3 ObjectQmgrName     char(48), /* Object queue manager */
      3 ResolvedObjectName char(48), /* Resolved Object name */
      3 ResolvedQmgrName   char(48); /* Resolved Object queue manager */
  /* Ver:1 */
      3 ObjectString,                /* Failing object long name */
         5 VSPtr pointer,            /* Address of variable length string */
         5 VSOffset fixed bin(31),   /* Offset of variable length string */
         5 VSBufSize fixed bin(31),  /* Size of buffer */
         5 VSLength fixed bin(31),   /* Length of variable length string */
         5 VSCCSID fixed bin(31);    /* CCSID of variable length string */
      3 SubName,                     /* Failing subscription name */
         5 VSPtr pointer,            /* Address of variable length string */
         5 VSOffset fixed bin(31),   /* Offset of variable length string */
         5 VSBufSize fixed bin(31),  /* Size of buffer */
         5 VSLength fixed bin(31),   /* Length of variable length string */
         5 VSCCSID fixed bin(31);    /* CCSID of variable length string */
     3 OpenOptions fixed bin(31),    /* Failing open options */
     3 SubOptions fixed bin(31);     /* Failing subscription options */
  /* Ver:2 */

High Level Assembler declaration for MQSTS


    MQSTS                         DSECT
    MQSTS_STRUCID                 DS    CL4   Structure identifier
    MQSTS_VERSION                 DS    F     Structure version number
    MQSTS_COMPCODE                DS    F     Completion code
    MQSTS_REASON                  DS    F     Reason code
    MQSTS_PUTSUCCESSCOUNT         DS    F     Success count
    MQSTS_PUTWARNINGCOUNT         DS    F     Warning count
    MQSTS_PUTFAILURECOUNT         DS    F     Failure count
    MQSTS_OBJTYPE                 DS    F     Object type
    MQSTS_OBJNAME                 DS    CL48  Object name
    MQSTS_OBJQMGR                 DS    CL48  Object queue manager
    MQSTS_ROBJNAME                DS    CL48  Resolved object name
    MQSTS_ROBJQMGR                DS    CL48  Resolved object queue manager
    MQSTS_OBJECTSTRING            DS    0F   Force fullword alignment
    MQSTS_OBJECTSTRING_VSPTR      DS    A  Address of variable length string
    MQSTS_OBJECTSTRING_VSOFFSET   DS    F  Offset of variable length string
    MQSTS_OBJECTSTRING_VSBUFSIZE  DS    F  Size of buffer
    MQSTS_OBJECTSTRING_VSLENGTH   DS    F  Length of variable length string
    MQSTS_OBJECTSTRING_VSCCSID    DS    F  CCSID of variable length string
    MQSTS_OBJECTSTRING_LENGTH     EQU   *-MQSTS_OBJECTSTRING
                                        ORG   MQSTS_OBJECTSTRING
    MQSTS_OBJECTSTRING_AREA       DS    CL(MQSTS_OBJECTSTRING_LENGTH) 
    *
    MQSTS_SUBNAME                 DS    0F Force fullword alignment
    MQSTS_SUBNAME_VSPTR           DS    A  Address of variable length string
    MQSTS_SUBNAME_VSOFFSET        DS    F  Offset of variable length string
    MQSTS_SUBNAME_VSBUFSIZE       DS    F  Size of buffer
    MQSTS_SUBNAME_VSLENGTH        DS    F  Length of variable length string
    MQSTS_SUBNAME_VSCCSID         DS    F  CCSID of variable length string
    MQSTS_SUBNAME_LENGTH          EQ    *-MQSTS_SUBNAME
                                        ORG   MQSTS_SUBNAME
    MQSTS_SUBNAME_AREA            DS    CL(MQSTS_SUBNAME_LENGTH) 
    *
    MQSTS_OPENOPTIONS             DS    F  Failing open options
    MQSTS_SUBOPTIONS              DS    F  Failing subscription option
    MQSTS_LENGTH                  EQU   *-MQSTS
                                  ORG   MQSTS
    MQSTS_AREA                    DS    CL(MQSTS_LENGTH)