This information is for reference. It describes the TXSeries for Multiplatforms application programming interface (API). It contains reference information that you need when you use CICS® API commands to prepare application programs on the following platforms: AIX®, HP-UX, Linux, and Windows. Supported programming languages include COBOL, PL/I, C, and C++. (HP-UX does not support C++; HP-UX and Linux does not support PL/I.)
Guidance information is in Programming applications and Troubleshooting. For information about debugging CICS applications, see Troubleshooting.
The information is intended primarily for use by application programmers, but will also be useful to system programmers and systems analysts. Because CICS resource definitions are referred to throughout this reference, you should be familiar with how they are defined and used in CICS. Resource definitions are described in Resource definitions. Programming for intercommunications requires a working knowledge of TCP/IP, SNA, or both, and might require a working knowledge of the PPC Gateway server.
Roadmap for this information
See Table 1 for the information on the various topics covered in this reference.
| If you want to... | Refer to... |
|---|---|
| Look up syntax and parameters of an API command | Use of CICS API commands and The CICS API commands by function |
| Read about individual commands | CICS API command reference |
| Look up Java API commands | Java API command reference |
| Look up EXEC interface block (EIB) fields | EXEC interface block (EIB) fields. |
| Look up BMS-related constants | BMS-related constants |
| Look up translated code for CICS API commands | Translated code for CICS API commands |
| Look up CICS terminal control | CICS terminal control |
| Define BMS mapsets, maps, and fields | Supported BMS definition macros |
| Look up CVDAs recognized by the translator | CVDAs recognized by the translator |
| Look up CICS conditions | CICS conditions |
| Know about Query Transaction Class interface | The Query Transaction Class interface |
| Know about CICS commands used in application programming | CICS commands used in application programming |
| Know about configuration services | Configuration services |
The commands that are described in CICS API command reference are listed in alphabetical order and use a standard format, as follows:
Review Use of CICS API commands and The CICS API commands by function before using the command reference, because the general information about the commands is given here. You will be referred to the other relevant topics as required.
This information contains information for all TXSeries for Multiplatforms products. Where the information is different for a specific TXSeries for Multiplatforms product, the words “on product” are used in line with the text, usually in a list or enclosed in parenthesis. Refer to the following examples: