MQPD - Property descriptor

The MQPD structure is used to define the attributes of a property. The structure is an input/output parameter on the MQSETMP call and an output parameter on the MQINQMP call.

Availability

The MQPD structure is available on the following platforms:

AIX®
IBM® i
Linux®
Solaris
Windows
z/OS®

and for IBM MQ MQI clients.

Character set and encoding

Data in MQPD must be in the character set of the application and encoding of the application ( MQENC_NATIVE ).

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 MQPD
Field name and description	Name of constant	Initial value (if any) of constant
StrucId (structure identifier)	MQPD_STRUC_ID	`'PD'`
Version (structure version number)	MQPD_VERSION_1	`1`
Options (options)	MQPD_NONE	`0`
Support (required support for message property)	MQPD_SUPPORT_OPTIONAL	`0`
Context (message context to which property belongs)	MQPD_NO_CONTEXT	`0`
CopyOptions (copy options to which property belongs)	MQCOPY_DEFAULT	`0`
Notes: In the C programming language, the macro variable MQPD_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: `MQPD MyPD = {MQPD_DEFAULT};`

Language declarations

C declaration for MQPD


typedef struct tagMQPD MQPD;
struct tagMQPD {
  MQCHAR4  StrucId;     /* Structure identifier */
  MQLONG   Version;     /* Structure version number */
  MQLONG   Options;     /* Options that control the action of
                           MQSETMP and MQINQMP */
  MQLONG   Support;     /* Property support option */
  MQLONG   Context;     /* Property context */
  MQLONG   CopyOptions; /* Property copy options */
};

COBOL declaration for MQPD


**   MQPD structure
  10 MQPD.
**    Structure identifier
   15 MQPD-STRUCID PIC X(4).
**    Structure version number
   15 MQPD-VERSION PIC S9(9) BINARY.
**    Options that control the action of MQSETMP and
**    MQINQMP
   15 MQPD-OPTIONS PIC S9(9) BINARY.
**    Property support option
   15 MQPD-SUPPORT PIC S9(9) BINARY.
**    Property context
   15 MQPD-CONTEXT PIC S9(9) BINARY.
**    Property copy options
   15 MQPD-COPYOPTIONS PIC S9(9) BINARY.

PL/I declaration for MQPD


dcl
 1 MQPD based,
  3 StrucId     char(4),       /* Structure identifier */
  3 Version     fixed bin(31), /* Structure version number */
  3 Options     fixed bin(31), /* Options that control the action
                                  of MQSETMP and MQINQMP */
  3 Support     fixed bin(31), /* Property support option */
  3 Context     fixed bin(31), /* Property context */
  3 CopyOptions fixed bin(31); /* Property copy options */

High Level Assembler declaration for MQPD


MQPD             DSECT
MQPD_STRUCID     DS   CL4    Structure identifier
MQPD_VERSION     DS   F      Structure version number
MQPD_OPTIONS     DS   F      Options that control the
*                            action of MQSETMP and MQINQMP
MQPD_SUPPORT     DS   F      Property support option
MQPD_CONTEXT     DS   F      Property context
MQPD_COPYOPTIONS DS   F      Property copy options
MQPD_LENGTH      EQU  *-MQPD
MQPD_AREA        DS   CL(MQPD_LENGTH)