TXSeries for Multiplatforms
Application Programming Reference
Ve r s i o n 6. 0
SC34-6640-00
TXSeries for Multiplatforms
Application Programming Reference
Ve r s i o n 6. 0
SC34-6640-00
Note
Before using this information and the product it supports, be sure to read the general information under “Notices” on page
601.
First Edition (November 2005)
This edition replaces SC09-4461-05.
Order publications through your IBM representative or through the IBM branch office serving your locality.
© Copyright International Business Machines Corporation 1999, 2005. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Figures . . . . . . . . . . . . . . vii
Tables . . . . . . . . . . . . . . .ix
About this book . . . . . . . . . . .xi
Who should read this book . . . . . . . . .xi
Document organization . . . . . . . . . .xi
Conventions used in this book . . . . . . . . xii
How to send your comments . . . . . . . . xiv
Chapter 1. Using the CICS API
commands . . . . . . . . . . . . .1
Command format . . . . . . . . . . . . .1
Conventions used in EXEC CICS commands . . . .2
API command argument values . . . . . . . .3
Replacing arguments when programming with
COBOL . . . . . . . . . . . . . . .3
Replacing arguments when programming with C
or C++ . . . . . . . . . . . . . . .4
Replacing arguments when programming with
PL/I . . . . . . . . . . . . . . . .5
Data types used in C or C++ . . . . . . . .6
Restrictions on the use of MBCS data . . . . .7
CICS-value data areas (CVDA) . . . . . . . .7
Command options . . . . . . . . . . . .8
INTO and SET . . . . . . . . . . . . .8
KEYLENGTH and RIDFLD . . . . . . . .9
LENGTH . . . . . . . . . . . . . .9
NOHANDLE . . . . . . . . . . . . .9
RESP and RESP2 . . . . . . . . . . .10
SYSID . . . . . . . . . . . . . . .10
NOEDF . . . . . . . . . . . . . . .11
STATE . . . . . . . . . . . . . . .11
FILE . . . . . . . . . . . . . . . .12
Processing the IOERR condition . . . . . . .12
INQUIRE and SET commands . . . . . . . .12
Browsing resource definitions . . . . . . .14
Null values . . . . . . . . . . . . .16
PERFORM SHUTDOWN SPI Command . . . . .17
The CICS API commands by function . . . . .17
Error handling and abnormal termination
support commands . . . . . . . . . . .17
APPC Mapped conversation commands . . . .18
Authentication commands . . . . . . . .18
Basic Mapping Support (BMS) commands . . .18
Debugging services commands . . . . . . .19
Configuration services commands . . . . . .19
File services commands . . . . . . . . .20
Timer services commands . . . . . . . .21
Journal services commands . . . . . . . .21
Program execution services commands . . . .21
Storage services commands . . . . . . . .21
Logical unit of work (LUW) services commands 21
Serialization services commands . . . . . .22
Temporary storage queue services commands . .22
Terminal services commands . . . . . . .22
Transient data queue services commands . . .22
Chapter 2. CICS API command
reference . . . . . . . . . . . . . .23
CICS API command information layout . . . . .23
ABEND . . . . . . . . . . . . . . .24
ADDRESS . . . . . . . . . . . . . . .25
ALLOCATE . . . . . . . . . . . . . .27
ASKTIME . . . . . . . . . . . . . . .29
ASSIGN . . . . . . . . . . . . . . .30
CANCEL . . . . . . . . . . . . . . .38
CHANGE PASSWORD . . . . . . . . . .40
COLLECT STATISTICS . . . . . . . . . .42
CONNECT PROCESS . . . . . . . . . . .45
CONVERSE (APPC) . . . . . . . . . . .48
CONVERSE (terminal) . . . . . . . . . . .51
DELAY . . . . . . . . . . . . . . . .54
DELETE . . . . . . . . . . . . . . .57
DELETEQ TD . . . . . . . . . . . . .62
DELETEQ TS . . . . . . . . . . . . . .64
DEQ . . . . . . . . . . . . . . . . .66
DUMP . . . . . . . . . . . . . . . .68
ENDBR . . . . . . . . . . . . . . . .72
ENQ . . . . . . . . . . . . . . . . .75
ENTER . . . . . . . . . . . . . . . .78
EXTRACT ATTRIBUTES . . . . . . . . . .80
EXTRACT PROCESS . . . . . . . . . . .82
FORMATTIME . . . . . . . . . . . . .84
FREE . . . . . . . . . . . . . . . .88
FREEMAIN . . . . . . . . . . . . . .90
GETMAIN . . . . . . . . . . . . . . .92
HANDLE ABEND . . . . . . . . . . . .94
HANDLE AID . . . . . . . . . . . . .96
HANDLE CONDITION . . . . . . . . . .99
IGNORE CONDITION . . . . . . . . . . 102
INQUIRE CONNECTION . . . . . . . . . 104
INQUIRE CONNECTION (browse) . . . . . . 109
INQUIRE DSNAME . . . . . . . . . . . 111
INQUIRE FILE . . . . . . . . . . . . .115
INQUIRE FILE (browse) . . . . . . . . . . 122
INQUIRE JOURNALNUM . . . . . . . . . 124
INQUIRE JOURNALNUM (browse) . . . . . . 126
INQUIRE MODENAME . . . . . . . . . . 128
INQUIRE PROGRAM . . . . . . . . . . 130
INQUIRE PROGRAM (browse) . . . . . . . 136
INQUIRE REQID . . . . . . . . . . . . 138
INQUIRE STATISTICS . . . . . . . . . . 143
INQUIRE SYSTEM . . . . . . . . . . . 147
INQUIRE TASK . . . . . . . . . . . . 156
INQUIRE TASK LIST . . . . . . . . . . . 164
INQUIRE TCLASS . . . . . . . . . . . 166
INQUIRE TDQUEUE . . . . . . . . . . . 167
INQUIRE TDQUEUE (browse) . . . . . . . 173
INQUIRE TERMINAL or NETNAME . . . . . 175
© Copyright IBM Corp. 1999, 2005 iii
- 1
- 2
前往页