CICS Transaction Server for z/OS
CICS Application Programming ReferenceVersion 3 Release 1
SC34-6434-08
CICS Transaction Server for z/OS
CICS Application Programming ReferenceVersion 3 Release 1
SC34-6434-08
ii Application Programming Reference
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiWhat this book is about . . . . . . . . . . . . . . . . . . . . . . xi
Who should read this book . . . . . . . . . . . . . . . . . . . . xiWhat you need to know to understand this book . . . . . . . . . . . . xiHow to use this book . . . . . . . . . . . . . . . . . . . . . . xiWhat this book does not cover . . . . . . . . . . . . . . . . . . xi
Notes on terminology . . . . . . . . . . . . . . . . . . . . . . . xi
Summary of changes . . . . . . . . . . . . . . . . . . . . . . xiiiChanges for CICS Transaction Server for z/OS, Version 3 Release 1 . . . . . xiiiChanges for CICS Transaction Server for z/OS, Version 2 Release 3 . . . . . xvChanges for CICS Transaction Server for z/OS, Version 2 Release 2 and CICS
Transaction Server for z/OS, Version 2 Release 1 . . . . . . . . . . . xvChanges for the CICS Transaction Server for OS/390 Version 1 Release 3
edition . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
CICS API commands. . . . . . . . . . . . . . . . . . . . . . . 1About the CICS API commands . . . . . . . . . . . . . . . . . . . 1
CICS API command format . . . . . . . . . . . . . . . . . . . . 1CICS command syntax notation . . . . . . . . . . . . . . . . . . 2CICS command argument values . . . . . . . . . . . . . . . . . 3CICS command restrictions . . . . . . . . . . . . . . . . . . . . 8LENGTH options in CICS commands . . . . . . . . . . . . . . . . 8NOHANDLE option . . . . . . . . . . . . . . . . . . . . . . . 9RESP and RESP2 options . . . . . . . . . . . . . . . . . . . . 9Translated code for CICS commands. . . . . . . . . . . . . . . . 10CICS-value data areas (cvdas) . . . . . . . . . . . . . . . . . . 16CICS threadsafe commands in the API . . . . . . . . . . . . . . . 16Threadsafe command list . . . . . . . . . . . . . . . . . . . . 17
CICS command summary . . . . . . . . . . . . . . . . . . . . . 19ABEND. . . . . . . . . . . . . . . . . . . . . . . . . . . . 27ACQUIRE. . . . . . . . . . . . . . . . . . . . . . . . . . . 29ADD SUBEVENT . . . . . . . . . . . . . . . . . . . . . . . . 32ADDRESS . . . . . . . . . . . . . . . . . . . . . . . . . . 34ADDRESS SET . . . . . . . . . . . . . . . . . . . . . . . . 36ALLOCATE (APPC) . . . . . . . . . . . . . . . . . . . . . . . 37ALLOCATE (LUTYPE6.1) . . . . . . . . . . . . . . . . . . . . . 41ALLOCATE (MRO) . . . . . . . . . . . . . . . . . . . . . . . 43ASKTIME . . . . . . . . . . . . . . . . . . . . . . . . . . . 45ASSIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . 46BIF DEEDIT . . . . . . . . . . . . . . . . . . . . . . . . . . 60BUILD ATTACH (LUTYPE6.1) . . . . . . . . . . . . . . . . . . . 62BUILD ATTACH (MRO) . . . . . . . . . . . . . . . . . . . . . . 65CANCEL . . . . . . . . . . . . . . . . . . . . . . . . . . . 68CANCEL (BTS). . . . . . . . . . . . . . . . . . . . . . . . . 70CHANGE PASSWORD . . . . . . . . . . . . . . . . . . . . . . 73CHANGE TASK . . . . . . . . . . . . . . . . . . . . . . . . 75CHECK ACQPROCESS . . . . . . . . . . . . . . . . . . . . . 76CHECK ACTIVITY . . . . . . . . . . . . . . . . . . . . . . . 78
Copyright IBM Corp. 1989, 2010 iii
CHECK TIMER. . . . . . . . . . . . . . . . . . . . . . . . . 81CONNECT PROCESS . . . . . . . . . . . . . . . . . . . . . . 83CONVERSE (VTAM default) . . . . . . . . . . . . . . . . . . . . 86CONVERSE (APPC) . . . . . . . . . . . . . . . . . . . . . . . 86CONVERSE (LUTYPE2/LUTYPE3) . . . . . . . . . . . . . . . . . 87CONVERSE (LUTYPE4) . . . . . . . . . . . . . . . . . . . . . 87CONVERSE (LUTYPE6.1) . . . . . . . . . . . . . . . . . . . . 88CONVERSE (SCS) . . . . . . . . . . . . . . . . . . . . . . . 88CONVERSE (3270 logical) . . . . . . . . . . . . . . . . . . . . 89CONVERSE (3600-3601) . . . . . . . . . . . . . . . . . . . . . 90CONVERSE (3600-3614) . . . . . . . . . . . . . . . . . . . . . 91CONVERSE (3650 interpreter) . . . . . . . . . . . . . . . . . . . 91CONVERSE (3650-3270) . . . . . . . . . . . . . . . . . . . . . 92CONVERSE (3650-3653) . . . . . . . . . . . . . . . . . . . . . 92CONVERSE (3650-3680) . . . . . . . . . . . . . . . . . . . . . 93CONVERSE (3767) . . . . . . . . . . . . . . . . . . . . . . . 93CONVERSE (3770) . . . . . . . . . . . . . . . . . . . . . . . 94CONVERSE (3790 full-function or inquiry) . . . . . . . . . . . . . . . 94CONVERSE (3790 3270-display) . . . . . . . . . . . . . . . . . . 95CONVERSE: VTAM options . . . . . . . . . . . . . . . . . . . . 95CONVERSE (non-VTAM default) . . . . . . . . . . . . . . . . . . 100CONVERSE (MRO) . . . . . . . . . . . . . . . . . . . . . . 101CONVERSE (2260). . . . . . . . . . . . . . . . . . . . . . . 101CONVERSE (3270 display) . . . . . . . . . . . . . . . . . . . . 102CONVERSE: non-VTAM options . . . . . . . . . . . . . . . . . . 102CONVERTTIME . . . . . . . . . . . . . . . . . . . . . . . . 107DEFINE ACTIVITY . . . . . . . . . . . . . . . . . . . . . . . 109DEFINE COMPOSITE EVENT. . . . . . . . . . . . . . . . . . . 112DEFINE COUNTER and DEFINE DCOUNTER. . . . . . . . . . . . . 114DEFINE INPUT EVENT . . . . . . . . . . . . . . . . . . . . . 118DEFINE PROCESS. . . . . . . . . . . . . . . . . . . . . . . 119DEFINE TIMER . . . . . . . . . . . . . . . . . . . . . . . . 122DELAY . . . . . . . . . . . . . . . . . . . . . . . . . . . 125DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 128DELETE ACTIVITY . . . . . . . . . . . . . . . . . . . . . . . 135DELETE CONTAINER (BTS) . . . . . . . . . . . . . . . . . . . 137DELETE CONTAINER (CHANNEL) . . . . . . . . . . . . . . . . . 139DELETE COUNTER and DELETE DCOUNTER . . . . . . . . . . . . 140DELETE EVENT . . . . . . . . . . . . . . . . . . . . . . . . 142DELETE TIMER . . . . . . . . . . . . . . . . . . . . . . . . 144DELETEQ TD . . . . . . . . . . . . . . . . . . . . . . . . . 145DELETEQ TS . . . . . . . . . . . . . . . . . . . . . . . . . 147DEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149DOCUMENT CREATE. . . . . . . . . . . . . . . . . . . . . . 151DOCUMENT INSERT . . . . . . . . . . . . . . . . . . . . . . 155DOCUMENT RETRIEVE . . . . . . . . . . . . . . . . . . . . . 158DOCUMENT SET . . . . . . . . . . . . . . . . . . . . . . . 160DUMP TRANSACTION . . . . . . . . . . . . . . . . . . . . . 163ENDBR . . . . . . . . . . . . . . . . . . . . . . . . . . . 168ENDBROWSE ACTIVITY . . . . . . . . . . . . . . . . . . . . 170ENDBROWSE CONTAINER . . . . . . . . . . . . . . . . . . . 171ENDBROWSE EVENT . . . . . . . . . . . . . . . . . . . . . 172ENDBROWSE PROCESS . . . . . . . . . . . . . . . . . . . . 173ENQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174ENTER TRACENUM . . . . . . . . . . . . . . . . . . . . . . 178EXTRACT ATTACH (LUTYPE6.1) . . . . . . . . . . . . . . . . . 180
iv Application Programming Reference
EXTRACT ATTACH (MRO) . . . . . . . . . . . . . . . . . . . . 184EXTRACT ATTRIBUTES (APPC). . . . . . . . . . . . . . . . . . 188EXTRACT ATTRIBUTES (MRO) . . . . . . . . . . . . . . . . . . 190EXTRACT CERTIFICATE . . . . . . . . . . . . . . . . . . . . 192EXTRACT LOGONMSG . . . . . . . . . . . . . . . . . . . . . 195EXTRACT PROCESS . . . . . . . . . . . . . . . . . . . . . . 197EXTRACT TCPIP . . . . . . . . . . . . . . . . . . . . . . . 199EXTRACT TCT . . . . . . . . . . . . . . . . . . . . . . . . 202FORCE TIMER . . . . . . . . . . . . . . . . . . . . . . . . 203FORMATTIME . . . . . . . . . . . . . . . . . . . . . . . . 205FREE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210FREE (APPC) . . . . . . . . . . . . . . . . . . . . . . . . . 211FREE (LUTYPE6.1) . . . . . . . . . . . . . . . . . . . . . . 213FREE (MRO) . . . . . . . . . . . . . . . . . . . . . . . . . 214FREEMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . 216GDS ALLOCATE. . . . . . . . . . . . . . . . . . . . . . . . 219GDS ASSIGN . . . . . . . . . . . . . . . . . . . . . . . . . 222GDS CONNECT PROCESS . . . . . . . . . . . . . . . . . . . 223GDS EXTRACT ATTRIBUTES. . . . . . . . . . . . . . . . . . . 226GDS EXTRACT PROCESS. . . . . . . . . . . . . . . . . . . . 228GDS FREE. . . . . . . . . . . . . . . . . . . . . . . . . . 230GDS ISSUE ABEND . . . . . . . . . . . . . . . . . . . . . . 232GDS ISSUE CONFIRMATION . . . . . . . . . . . . . . . . . . . 234GDS ISSUE ERROR . . . . . . . . . . . . . . . . . . . . . . 236GDS ISSUE PREPARE . . . . . . . . . . . . . . . . . . . . . 238GDS ISSUE SIGNAL . . . . . . . . . . . . . . . . . . . . . . 240GDS RECEIVE . . . . . . . . . . . . . . . . . . . . . . . . 242GDS SEND. . . . . . . . . . . . . . . . . . . . . . . . . . 245GDS WAIT . . . . . . . . . . . . . . . . . . . . . . . . . . 248GET CONTAINER (BTS) . . . . . . . . . . . . . . . . . . . . . 250GET CONTAINER (CHANNEL) . . . . . . . . . . . . . . . . . . 253GET COUNTER and GET DCOUNTER . . . . . . . . . . . . . . . 256GETMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . 261GETNEXT ACTIVITY . . . . . . . . . . . . . . . . . . . . . . 265GETNEXT CONTAINER . . . . . . . . . . . . . . . . . . . . . 267GETNEXT EVENT . . . . . . . . . . . . . . . . . . . . . . . 269GETNEXT PROCESS . . . . . . . . . . . . . . . . . . . . . . 271HANDLE ABEND . . . . . . . . . . . . . . . . . . . . . . . 273HANDLE AID . . . . . . . . . . . . . . . . . . . . . . . . . 275HANDLE CONDITION. . . . . . . . . . . . . . . . . . . . . . 277IGNORE CONDITION . . . . . . . . . . . . . . . . . . . . . . 279INQUIRE ACTIVITYID . . . . . . . . . . . . . . . . . . . .