IBM MQ COPY, header, include, and module files

Information to help you use COPY, header, include, and module files with the MQI, for various programming languages.

C header files

These header files help you write C application programs that use the MQI. The C header files are summarized in the following table:

Table 1. C header files - call prototypes, data types, return codes, constants, and structures
File name Description IBM® i AIX® and Linux® systems Windows z/OS®
Call prototypes, data types, return codes, constants, and structures
CMQC MQI definitions C C C C
CMQBC MQAI definitions C C C  
CMQEC Interface Entry Points definition (includes CMQC, CMQXC and CMQZC)   C C  
CMQCFC PCF definitions C C C C
CMQPSC Publish/Subscribe definitions C C C C
CMQXC Channel and exit definitions C C C C
CMQZC Installable services definitions C C C  

Key: C= Files provided

COBOL COPY files

These COPY files help you write COBOL application programs that use the MQI. The COBOL COPY files are summarized in the following table:

Table 2. COBOL copy files - return codes, constants, and structures
File name Description IBM i AIX and Linux Windows z/OS
Return codes and constants
CMQx MQI definitions V V V V
CMQCFx PCF definitions V V V V
CMQPSx Publish/Subscribe definitions V V V V
CMQXx Channel and exit definitions V V V V
Structures
CMQAIRx MQAIR - Authentication information record   V L V L  
CMQBOx MQBO - Begin options V L V L V L  
CMQCDx MQCD - Channel definition V L V L V L V L
CMQCFBFx MQCFBF - PCF byte string filter parameter V L V L V L V L
CMQCFBSx MQCFBS - PCF byte string parameter V L V L V L V L
CMQCFGRx MQCFGR - PCF group parameter V L V L V L V L
CMQCFHx MQCFH - PCF header V L V L V L V L
CMQCFIFx MQCFIF - PCF integer filter parameter V L V L V L V L
CMQCFILx MQCFIL - PCF integer list parameter V L V L V L V L
CMQCFINx MQCFIN - PCF integer parameter V L V L V L V L
CMQCFSFx MQCFSF - PCF string filter parameter V L V L V L V L
CMQCFSLx MQCFSL - PCF string list parameter V L V L V L V L
CMQCFSTx MQCFST - PCF string parameter V L V L V L V L
CMQCFXLx MQCFIL64 - PCF 64-bit integer list parameter V L V L V L V L
CMQCFXNx MQCFIN64 - PCF 64-bit integer parameter V L V L V L V L
CMQCHRVx MQCHARV - Variable length string V L V L V L V L
CMQCIHx MQCIH - CICS® bridge header V L V L V L V L
CMQCNOx MQCNO - Connect options V L V L V L V L
CMQCSPx MQCSP - Security parameters V L V L V L V L
CMQCXPx MQCXP - Channel exit parameters V L     V L
CMQDHx MQDH - Distribution header V L V L V L V L
CMQDLHx MQDLH - Dead-letter header V L V L V L V L
CMQDXPx MQDXP - Data conversion exit parameters V L   V L  
CMQEPHx MQEPH - Embedded PCF header V L V L V L V L
CMQGMOx MQGMO - Get message options V L V L V L V L
CMQIIHx MQIIH - IMS information header V L V L V L V L
CMQMDx MQMD - Message descriptor V L V L V L V L
CMQMD1x MQMD1 - Message descriptor version 1 V L V L V L V L
CMQMD2x MQMD2 - Message descriptor version 2 V L V L V L V L
CMQMDEx MQMDE - Message descriptor extended V L V L V L V L
CMQODx MQOD - Object descriptor V L V L V L V L
CMQORx MQOR - Object record V L V L V L V L
CMQPMOx MQPMO - Put message options V L V L V L V L
CMQRFHx MQRFH - Rules and formatting header V L V L V L V L
CMQRFH2x MQRFH2 - Rules and formatting header 2 V L V L V L V L
CMQRMHx MQRMH - Reference message header V L V L V L V L
CMQRRx MQRR - Response record V L V L V L  
CMQSCOx MQSCO - TLS configuraton options   V L V L  
CMQTMx MQTM - Trigger message V L   V L V L
CMQTMCx MQTMC - Trigger message character V L V L    
CMQTMC2x MQTMC2 - Trigger message 2 character V L V L V L V L
CMQWIHx MQWIH - Work information header V L V L V L V L
CMQXQHx MQXQH - Transmission queue header V L V L V L V L
Key:
  • Files with initial values provided, x=V
  • Files without initial values provided, x=L
[z/OS]

PL/I include files

These include files help you write PL/I application programs that use the MQI. These files are available on z/OS only. They are summarized in the following table:

Table 3. PL/I include files - data types, return codes, constants, and structures
File name Description IBM i AIX and Linux Windows z/OS
Data types, return codes, constants, and structures
CMQP MQI definitions       P
CMQCFP PCF definitions       P
CMQEPP Entry point definitions       P
CMQPSP Publish/Subscribe definitions       P
CMQXP Channel and exit definitions       P

Key: P= File provided

[IBM i]

RPG copy files

These copy files help you write RPG application programs that use the MQI. These files are available on IBM i only. They are summarized in the following table:

Table 4. RPG copy files - return codes, constants, and structures
File name Description IBM i AIX and Linux Windows z/OS
Return codes and constants
CMQx MQI definitions G R      
CMQCFx PCF definitions G      
CMQPSx Publish/Subscribe definitions G      
CMQXx Channel and exit definitions G R      
Structures
CMQBOx MQBO - Begin options G H      
CMQCDx MQCD - Channel definition G H R      
CMQCFBFx MQCFBF - PCF byte string filter parameter G H      
CMQCFBSx MQCFBS - PCF byte string parameter G H      
CMQCFGRx MQCFGR - PCF group parameter G H      
CMQCFHx MQCFH - PCF header G H      
CMQCFIFx MQCFIF - PCF integer filter parameter G H      
CMQCFILx MQCFIL - PCF integer list parameter G H      
CMQCFINx MQCFIN - PCF integer parameter G H      
CMQCFSFx MQCFSF - PCF string filter parameter G H      
CMQCFSLx MQCFSL - PCF string list parameter G H      
CMQCFSTx MQCFST - PCF string parameter G H      
CMQCFXLx MQCFIL64 - PCF 64-bit integer list parameter G H      
CMQCFXNx MQCFIN64 - PCF 64-bit integer parameter G H      
CMQCHARVx MQCHARV - Variable length string G H      
CMQCIHx MQCIH - CICS bridge header G H      
CMQCNOx MQCNO - Connect options G H      
CMQCSPx MQCSP - Security parameters G H      
CMQCXPx MQCXP - Channel exit parameters G H R      
CMQDHx MQDH - Distribution header G H R      
CMQDLHx MQDLH - Dead-letter header G H R      
CMQDXPx MQDXP - Data conversion exit parameters G H R      
CMQEPHx MQEPH - Embedded PCF header G H      
CMQGMOx MQGMO - Get message options G H R      
CMQIIHx MQIIH - IMS information header G H R      
CMQMDx MQMD - Message descriptor G H R      
CMQMD1x MQMD1 - Message descriptor version 1 G H R      
CMQMD2x MQMD2 - Message descriptor version 2 G H      
CMQMDEx MQMDE - Message descriptor extended G H R      
CMQODx MQOD - Object descriptor G H R      
CMQORx MQOR - Object record G H R      
CMQPMOx MQPMO - Put message options G H R      
CMQPXPx MQPXP - Publish/Subscribe routing exit parameters G H      
CMQRFHx MQRFH - Rules and formatting header G H      
CMQRFH2x MQRFH2 - Rules and formatting header 2 G H      
CMQRMHx MQRMH - Reference message header G H R      
CMQRRx MQRR - Response record G H R      
CMQTMx MQTM - Trigger message G H R      
CMQTMCx MQTMC - Trigger message character G H R      
CMQTMC2x MQTMC2 - Trigger message 2 character G H R      
CMQWIHx MQWIH - Work information header G H      
CMQXQHx MQXQH - Transmission queue header G H R      
Key:
  • File for static linkage, initialized, provided x=G
  • File for static linkage, not initialized, provided x=H
  • File for dynamic linkage, initialized, provided, x=R
[Windows]

Visual Basic module files

These header or form files help you write Visual Basic application programs that use the MQI. These files are available on Windows only. They are summarized in the following table:

Table 5. Visual Basic module files - call declarations, data types, return codes, constants, and structures
File name Description IBM i AIX and Linux systems Windows z/OS
Call declarations, data types, return codes, constants, and structures
CMQB MQI definitions     B  
CMQBB MQAI definitions     B  
CMQCFB PCF definitions     B  
CMQXB Channel and exit definitions     B  

Key: B= File provided

[z/OS]

z/OS Assembler COPY files

These COPY files help you write z/OS Assembler application programs that use the MQI. These files are summarized in the following table:

Table 6. z/OS Assembler copy files - data types, return codes, constants, and structures
File name Description IBM i AIX and Linux Windows z/OS
Data types, return codes, and constants
CMQA MQI definitions       A
CMQCFA PCF definitions       A
CMQPSA Publish/Subscribe definitions       A
CMQVERA Structure version control       A
CMQXA Channel and exit definitions       A
Structures
CMQCDA MQCD - Channel definition        
CMQCFBFA MQCFBF - PCF byte string filter parameter        
CMQCFBSA MQCFBS - PCF byte string parameter       A
CMQCFGRA MQCFGR - PCF group parameter       A
CMQCFHA MQCFH - PCF header       A
CMQCFIFA MQCFIF - PCF integer filter parameter       A
CMQCFILA MQCFIL - PCF integer list parameter       A
CMQCFINA MQCFIN - PCF integer parameter       A
CMQCFSFA MQCFSF - PCF string filter parameter       A
CMQCFSLA MQCFSL - PCF string list parameter       A
CMQCFSTA MQCFST - PCF string parameter       A
CMQCFXLA MQCFIL64 - PCF 64-bit integer list parameter       A
CMQCFXNA MQCFIN64 - PCF 64-bit integer parameter       A
CMQCHARVA MQCHARV - Variable length string       A
CMQCIHA MQCIH - CICS bridge header       A
CMQCNOA MQCNO - Connect options       A
CMQCSPA MQCSP - Security parameters       A
CMQCXPA MQCXP - Channel exit parameters       A
CMQDHA MQDH - Distribution header       A
CMQDLHA MQDLH - Dead-letter header       A
CMQDXPA MQDXP - Data conversion exit parameters       A
CMQEPHA MQEPH - Embedded PCF header       A
CMQGMOA MQGMO - Get message options       A
CMQIIHA MQIIH - IMS information header       A
CMQMDA MQMD - Message descriptor       A
CMQMD1A MQMD1 - Message descriptor version 1       A
CMQMD2A MQMD2 - Message descriptor version 2       A
CMQMDEA MQMDE - Message descriptor extended       A
CMQODA MQOD - Object descriptor       A
CMQORA MQOR - Object record       A
CMQPMOA MQPMO - Put message options       A
CMQRFHA MQRFH - Rules and formatting header       A
CMQRFH2A MQRFH2 - Rules and formatting header 2       A
CMQRMHA MQRMH - Reference message header       A
CMQTMA MQTM - Trigger message       A
CMQTMC2A MQTMC2 - Trigger message 2 character       A
CMQWCRA MQWCR - Cluster workload cluster record       A
CMQWDRA MQWDR - Cluster workload destination record       A
CMQWDR1A MQWDR1 - Cluster workload destination record version 1       A
CMQWDR2A MQWDR2 - Cluster workload destination record version 2       A
CMQWIHA MQWIH - Work information header       A
CMQWQRA MQWQR - Cluster workload queue record       A
CMQWQR1A MQWQR1 - Cluster workload queue record version 1       A
CMQWQR2A MQWQR2 - Cluster workload queue record version 2       A
CMQWXPA MQWXP - Cluster workload exit parameters       A
CMQWXP1A MQWXP1 - Cluster workload exit parameters version 1       A
CMQWXP2A MQWXP2 - Cluster workload exit parameters version 2       A
CMQWXP3A MQWXP3 - Cluster workload exit parameters version 3       A
CMQXPA MQXP - CICS API-crossing exit parameters       A
CMQXQHA MQXQH - Transmission queue header       A
CMQXWDA MQXWD - Exit wait descriptor       A

Key: A= File provided