cics family api structure - support - ibm

CICS Family

API Structure

SC33-1007-02

IBM CICS Family

API Structure

SC33-1007-02

Third Edition (January 1997)

This edition applies to the following members of the family of IBM licensed programs that include the name Customer InformationControl System (CICS):

| � CICS Transaction Server for OS/390 Version 1, program number 5655-147

� CICS/ESA Version 4 Release 1, program number 5655-018

� CICS/ESA Version 3 Release 3, program number 5685-083

� CICS/ESA Version 3 Release 2 Modification 1, program number 5685-083

� CICS/ESA Version 3 Release 1 Modification 1, program number 5685-083

� CICS/MVS Version 2 Release 1 Modification 2, program number 5665-403

� CICS/MVS Version 2 Release 1 Modification 1, program number 5665-403

� CICS/OS/VS Version 1 Release 7, program number 5740-XX1

� CICS/VSE Version 2 Release 3, program number 5686-026



� CICS/DOS/VS Version 1 Release 7, program number 5746-XX3

� CICS for OS/2 Version 3, program number 5622-808

� CICS for OS/2 Version 2 Modification 1, program number 5648-036

� CICS OS/2 Version 2 program number 5688-101

� CICS OS/2 Version 1.20, program number 5688-101

| � CICS for AIX Version 2 Release 1 Modification 1, program number 5765-553

� CICS for AIX Version 2 Release 1, program number 5765-553

� CICS/6000 Version 1 Release 2, program number 5765-148

� CICS/6000 Version 1 Release 1 Modification 1, program number 5621-063

� CICS/6000 Version 1 Release 1 Modification 0, program number 5621-063

� CICS/400 Version 3 Release 1, program number 5763-DFH



It will also apply to all subsequent versions, releases, and modifications of these products until otherwise indicated in new editions.Consult the latest edition of the applicable IBM system bibliography for current information on these products.

| This book is based on the API Structure, SC33-1007-01, which is now obsolete. Changes from that edition are marked by vertical| lines to the left of the changes.

Order publications through your IBM representative or the IBM branch office serving your locality. Publications are not stocked at theaddresses given below.

At the back of this publication is a page entitled “Sending your comments to IBM”. If you want to make comments, but the methodsdescribed are not available to you, please address them to:

IBM United Kingdom Laboratories, Information Development,Mail Point 095, Hursley Park, Winchester, Hampshire, England, SO21 2JN.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believesappropriate without incurring any obligation to you.

Copyright International Business Machines Corporation 1992, 1997. All rights reserved.Note to U.S. Government Users — Documentation related to restricted rights — Use, duplication or disclosure is subject torestrictions set forth in GSA ADP Schedule Contract with IBM Corp.

Contents

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiProgramming interface information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiTrademarks and service marks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Summary of changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Functions, bases, and towers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Application programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Abend handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Advanced program-to-program communication (APPC) mapped . . . . . . . . . . . . . . . . . . . . 13

Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

BMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27The BMS application programming interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27The BMS map definition interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Diagnostic services—dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Diagnostic services—trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Environment services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57The ASSIGN command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Exception handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

File control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Interval control—task-related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Interval control—time-related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Interval control—event-related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Journal control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Program control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Program control—explicit loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Copyright IBM Corp. 1992, 1997 iii

Storage control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Syncpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Task control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Temporary storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Terminal control (3270) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Transient data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Systems programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

AUTOINSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129INQUIRE AUTINSTMODEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129INQUIRE AUTOINSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129SET AUTOINSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Communications - access method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131INQUIRE IRC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131SET IRC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131INQUIRE VTAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132SET VTAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Communications - connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135INQUIRE CONNECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135SET CONNECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137INQUIRE MODENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139SET MODENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Communications - terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141SET NETNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141INQUIRE TERMINAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141SET TERMINAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Communications - related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151INQUIRE PARTNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151INQUIRE PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151SET DELETSHIPPED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Data sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153INQUIRE DSNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153SET DSNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Diagnostic services - dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157INQUIRE DUMPDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157SET DUMPDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157INQUIRE SYSDUMPCODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158SET SYSDUMPCODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160INQUIRE TRANDUMPCODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161SET TRANDUMPCODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

iv API Structure

Diagnostic services - trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163INQUIRE TRACEDEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163SET TRACEDEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164INQUIRE TRACEFLAG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165SET TRACEFLAG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166INQUIRE TRACETYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167SET TRACETYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Environment services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171INQUIRE SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171SET SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177INQUIRE EXITPROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

File control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179INQUIRE FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179SET FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Journal control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187INQUIRE JOURNALMODEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187INQUIRE JOURNALNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187SET JOURNALNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188INQUIRE JOURNALNUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189SET JOURNALNUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190INQUIRE STREAMNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193INQUIRE MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193SET MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Program control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197INQUIRE PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197SET PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Queued requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201INQUIRE REQID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Recovery management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203INQUIRE UOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203SET UOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204INQUIRE UOWDSNFAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205INQUIRE UOWENQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206INQUIRE UOWLINK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207SET UOWLINK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209INQUIRE STATISTICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209SET STATISTICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Storage Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211INQUIRE STORAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Contents v

Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213INQUIRE TASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213SET TASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216INQUIRE TASK LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216INQUIRE TCLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217SET TCLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217INQUIRE TRANCLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217SET TRANCLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Temporary storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219INQUIRE TSQUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221INQUIRE TRANSACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221SET TRANSACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Transient data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225INQUIRE TDQUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225SET TDQUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229INQUIRE VOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229SET VOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

External interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

External Presentation Interface (EPI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233EPI Product Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233EPI Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234EPI Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

External Call Interface (ECI V0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

External Call Interface (ECI V1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

EXternal CICS Interface (EXCI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247EXCI—EXEC Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247EXCI—Call Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

External Transaction Initiation (ETI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249ETI Product Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249ETI External Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249ETI_PARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

vi API Structure

Notices

The following paragraph does not apply to any country where such provisions are inconsistentwith local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS”WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions,therefore this statement may not apply to you.

References in this publication to IBM products, programs, or services do not imply that IBM intends tomake these available in all countries in which IBM operates. Any reference to an IBM product, program,or service is not intended to state or imply that only that IBM product, program, or service may be used.Any functionally equivalent product, program, or service that does not infringe any of the intellectualproperty rights of IBM may be used instead of the IBM product, program, or service. The evaluation andverification of operation in conjunction with other products, except those expressly designated by IBM, arethe responsibility of the user.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including this one)and (ii) the mutual use of the information which has been exchanged, should contact Laboratory Counsel,MP151, IBM United Kingdom Laboratories, Hursley Park, Winchester, Hampshire, England SO21 2JN.Such information may be available, subject to appropriate terms and conditions, including in some cases,payment of a fee.

IBM may have patents or pending patent applications covering subject matter in this document. Thefurnishing of this document does not give you any license to these patents. You can send licenseinquiries, in writing, to the IBM Director of Licensing, IBM Corporation, 500 Columbus Avenue, Thornwood,New York 10594, U.S.A.

Programming interface information

This book is intended to help you write application programs using EXEC CICS commands. This bookdocuments General-use Programming Interface and Associated Guidance Information provided by CICS.

General-use programming interfaces allow the customer to write programs that obtain the services ofCICS.

Trademarks and service marks

The following terms, used in this publication, are trademarks or service marks of IBM Corporation in theUnited States or other countries:

| IBM| CICS| AIX| CICS/ESA

| CICS/MVS| CICS/VSE| CICS OS/2

| CICS/400| CICS/6000| ACF/VTAM

Copyright IBM Corp. 1992, 1997 vii

| The following terms, used in this publication, are trademarks of other companies:

| Microsoft, Windows, Windows NT, and the Windows 95 logo are trademarks or registered trademarks of| Microsoft Corporation.

| Digital is a trademark of Digital Equipment Corporation

| HP is a trademark of Hewlett-Packard Company

| Siemens Nixdorf SINIX is a trademark of Siemens Nixdorf Informationssysteme AG.

| Solaris is a trademark of Sun MicroSystems, Inc in the United States and other countries.

viii API Structure

Preface

About this book

This book gives you a quick reference to the level of support that each member of the CICS family givesto the CICS application programming interface (API) and the system programming INQUIRE and SETcommands. It complements the reference information for the API and SPI in the appropriate books foreach member. We’ve written it for CICS customers and software vendors who want to develop CICSapplications to run on more than one CICS family member, and it assumes that you are an experienceduser of the CICS API. This implies a good knowledge of CICS concepts and terminology, as well asfamiliarity with the CICS API itself, and with the information provided for the API and SPI.

The book divides the API and SPI into various functional areas, and, for each area:

� Lists the appropriate commands, options, and conditions.

� Shows you which family members support which options. Where the family members support optionsdifferently, it describes the differences.

This section gives you important information that you’ll need to use this book effectively, including:

� An introduction to the concepts of base and towers, central to the book’s description of the CICS API(“Functions, bases, and towers” on page 3)

� A description of the way that we present information in the books (“How we present the APIinformation” on page 3) and (“How we present the SPI information” on page 7)

� Some notes on what you shouldn’t expect from this book (“What you won’t find in this book” onpage x)

� A list of the API and SPI reference material provided by the CICS family members (“Other books youwill need” on page xi)

The final part of this book defines some external interfaces to CICS. These are not APIs for CICSapplications, but allow non-CICS applications to access CICS transactions.

Non-IBM systems

IBM has agreements with various other companies to provide implementations of CICS on non-IBMplatforms.

For planning purposes, regard the following systems as having functionally equivalent API support:

| � Transaction Server for Windows NT and CICS for AIX 2.1.1� CICS for Windows NT Version 2 and CICS for OS/2 Version 2.0.1

| � CICS for HP-UX Version 2 and CICS for AIX 2.1.1� CICS for HP 9000 1.4 and CICS/6000 Version 1.2� CICS for HP 9000 1.3 and CICS/6000 Version 1.2� CICS for Digital UNIX V2.1 and CICS for AIX V2.1� CICS for Siemens Nixdorf SINIX V2.1 and CICS for AIX Version 2.1

| � CICS for the Solaris Operating Environment and CICS for AIX 2.1

Copyright IBM Corp. 1992, 1997 ix

What you won’t find in this book

In this edition of the book, we don’t cover the following API elements:

� System programming commands, other than INQUIRE and SET � APPC basic� Batch data interchange

� Built-in functions � Console support � Report controller � Spooler� Terminal control support for devices other than 3270 and APPC (LU 6.2)� User-maintained data tables

We are still developing information on these areas, and expect to add that information to future editions.

x API Structure

Other books you will need

This book does not provide complete reference information to the syntax and semantics of the CICS API.To use this book effectively, you will need the application and system programming reference informationfor the CICS family members in which you’re interested.

The list below gives the titles and order numbers of the API and SPI reference manuals (or bookscontaining API reference information) for each family member.

CICS familymember

Book Order number

API SPI

| TS 1.1 OS/390| Application Programming Reference| SC33-1688| SC33-1689

ESA 4.1 Application Programming Reference SC33-1170 SC33-1171

ESA 3.3 Application Programming Reference SC33-0676 SC33-0670

ESA 3.2.1 Application Programming Reference SC33-0676 SC33-0670

ESA 3.1.1 Application Programmer’s Reference SC33-0676 SC33-0670

MVS 2.1.2 Application Programmer’s Reference SC33-0512

MVS 2.1.1 Application Programmer’s Reference SC33-0512

OS/VS 1.7 Application Programmer’s Reference Manual(Command Level)

SC33-0241

VSE 2.3 Application Programming Reference SC33-0713 SC33-0711

VSE 2.2 Application Programmer’s Reference SC33-0713 SC33-0911

VSE 2.1 Application Programmer’s Reference SC33-0713 SC33-0911

DOS/VS 1.7 Application Programmer’s Reference Manual(Command Level)

SC33-0077

OS/2 V3 Application Programming SC33-1585

OS/2 2.0.1 Application Programming SC33-1425

OS/2 V2 Application Programming SC33-0883

OS/2 1.20 System and Application Guide SC33-0616

| AIX 2.1.1| Application Programming Reference| SC33-1569

AIX 2.1 Application Programming Reference SC33-1569

6000 1.2 Application Programming Reference SC33-0886

6000 1.1.1 Application Programming Reference SC33-0886

6000 1.1.0 Application Programming Reference SC33-0886

400 3.1 Application Programming Guide SC33-1386



TS forWindows NT

Application Programming Guide SC33-1887

Preface xi

xii API Structure

Summary of changes

As the changes to this book are so extensive, we are only showing vertical bars in the left hand margin forthe preface and the external interfaces.

There is information about new platforms introduced since the last edition. These are:

� CICS Transaction Server for OS/390 V1.1� CICS for AIX V2.1.1 and its functional equivalents:

– Transaction Server fpr Windows NT– CICS for Siemens Nixdorf SINIX V2.1– CICS for the Solaris Operating Environment

| – CICS for HP-UX Version 2

Some API bases and towers have been changed:

Journal Control

� JN3 has been added

File Control

� FC6 has been added

Terminal Control

� TC8 has been added

BMS

� BMS1B has been re-instated.

Some new SPI has been added:

New Recovery Management functional group added

� UOW � UOWDSNFAIL � UOWENQ � UOWLINK

Journal Control new commands added

� JOURNALMODEL � JOURNALNAME � STREAMNAME

Some SPI has been extended:

INQUIRE

� CONNECTION � EXITPROGRAM � FILE � NETNAME � SYSTEM � TASK � TDQUEUE � TERMINAL � TRANSACTION � TSQUEUE

Copyright IBM Corp. 1992, 1997 xiii

SET

� CONNECTION � DSNAME � FILE

xiv API Structure

Introduction

Copyright IBM Corp. 1992, 1997 1

2 API Structure

Functions, bases, and towers

In this book, we divide the CICS API into functional areas. Each functional area represents a transactionprocessing function provided by at least one member of the CICS family.

Within each functional area, we further divide function into a base and a number of towers, to help youfind your way through the different levels of function provided by different members of the family.

| The base contains the minimum set of functions that must be available in any CICS system to support a| realistic distributed processing environment; it’s the function that makes CICS an effective transaction| processor.

| The definition of the base was made with the collaboration of the CICS Architecture Forum which contains| representatives both from IBM and external CICS implementers.

The towers build on the base functions, and provide transaction processing functions that increase theeffectiveness of CICS, or special functions relevant to particular CICS family members.

The function in a tower usually builds on the function in the corresponding base. However, a few towersbuild on function in another tower. The key point is that, without the presence of the base, none of thetowers provides useful function.

An example will make the concept of base and towers clearer. The following diagram shows thebase/tower structure for file control:

Table 1. File control base and towers

┌───┬───┬───┬───┐

│ F │ F │ F │ F │

│ C │ C │ C │ C │

│ 1 │ 4 │ 5 │ 6 │

├───┴───┴───┴───┤

│ │

│ BASE │

│ │

└───────────────┘

FC1 BDAM (DAM in VSE) supportFC4 RBA access to keyed filesFC5 Concurrent file updatesFC6 Record Level Sharing (RLS)

The file control base includes all the familiar file control functions (READ, WRITE, and so on) for VSAM orVSAM-like data access to keyed, addressed, and numbered data sets (KSDS, ESDS, and RRDS).

| The four file control towers provide BDAM data access (FC1) and additional function that applies only to| VSAM (FC4, FC5, F6).

How we present the API information

We describe each functional area in a separate section. Each section starts with a summary of supportfor that functional area: a graphical presentation of the base and towers structure, followed by a tableshowing support for the base and towers across the family. For example, here’s the support summary forthe task-related interval control functional area:


Table 2. Interval control—task-related base and towers

┌──────┐

│ I │

│ C │

│ K │

│ 5 │

├──────┤

│ │

│ BASE │

│ │

└──────┘

ICK5 FMH

Table 3. Interval control—task-related support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y D D D D D D D D D D

ICK5 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base D D D D D D D D D D D D

ICK5 N N N N N N N N N N N N

The support table uses the convention:

Y This function is supported by this memberN This function is not supportedD This function is supported, but there are differences from the standard definition.

Wherever you see a D for a member, you’ll find a corresponding entry in the differences table describedbelow.

In all tables, we use abbreviated forms of the family member names, as follows:

| TS 1.1 OS/390 CICS Transaction Server for OS/390 Version 1 Release 1ESA 4.1 CICS/ESA Version 4 Release 1ESA 3.3 CICS/ESA Version 3 Release 3ESA 3.2.1 CICS/ESA Version 3 Release 2 Modification 1ESA 3.1.1 CICS/ESA Version 3 Release 1 Modification 1MVS 2.1.2 CICS/MVS Version 2 Release 1 Modification 2MVS 2.1.1 CICS/MVS Version 2 Release 1 Modification 1OS/VS 1.7 CICS/OS/VS Version 1 Release 7VSE 2.3 CICS/VSE Version 2 Release 3VSE 2.2 CICS/VSE Version 2 Release 2VSE 2.1 CICS/VSE Version 2 Release 1DOS/VS 1.7 CICS/DOS/VS Version 1 Release 7OS/2 V3 CICS for OS/2 Version 3 (Transaction Server for OS/2, V4)OS/2 2.0.1 CICS for OS/2 Version 2 Modification 1OS/2 V2 CICS OS/2 Version 2OS/2 1.20 CICS OS/2 Version 1.20

| AIX 2.1.1 CICS for AIX Version 2 Release 1 Modification 1 (Transaction Server for AIX, V4)AIX 2.1 CICS for AIX Version 2 Release 16000 1.2 CICS/6000 Version 1 Release 26000 1.1.1 CICS/6000 Version 1 Release 1 Modification 16000 1.1.0 CICS/6000 Version 1 Release 1 Modification 0

4 API Structure

400 3.1 CICS/400 Version 3 Release 1400 2.3 CICS/400 Version 2 Release 3400 2.2 CICS/400 Version 2 Release 2

After the summary figure and support tables come the detailed descriptions of the base and towers. Westart with a brief description of the base, followed by a support table, showing support for the function inthe base only. Continuing with our previous example, here are the description and support table for thetask-related interval control base function.

Base

Request that a task be started, cancel the request before the task starts, and retrieve data for the taskonce it has started.

Table 4. Interval control—task-related base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y D D D D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D D D D D D D D D

We then have the standard definition table, which shows the commands, options, and conditions thatmake up the base function. Here’s the one for task-related interval control:

Table 5 (Page 1 of 2). Interval control—task-related base standard definition

Commands Options Conditions

CANCEL REQID�

SYSID�

TRANSID�

INVREQISCINVREQNOTAUTHNOTFNDSYSIDERR

RETRIEVE INTO�

LENGTH��

QUEUE�RTERMID�

RTRANSID�

SET�WAIT

ENDDATAENVDEFERRINVREQINVTSREQ1

IOERRLENGERRNOTFND

Functions, bases, and towers 5



START AFTERATFROM�

HOURS�INTERVAL�LENGTH�

MINUTES�NOCHECKQUEUE�PROTECTQUEUE�REQID�

RTERMID�

RTRANSID�

SECONDS�SYSID�

TERMID�

TIME�TRANSID�

USERID�

INVREQIOERRISCINVREQLENGERRNOTAUTHSYSIDERRTERMIDERRTRANSIDERRUSERIDERR

In this table, we use a simple convention to distinguish input and output options:

� Unmarked options have no user-supplied value or data area (for example, PROTECT above). If theoption is present in a command, you can assume that it is an input to the operation.

� A bullet (�) marks an option that introduces an input parameter (for example, FROM� above).

� A circle (�) marks an option that introduces an output parameter (for example, INTO� above).

� A bullet and circle together (��) mark an option that introduces a parameter used both for input andoutput (for example, LENGTH�� above).

After the standard definition table, comes the differences table, where applicable. For every D in thesupport table, you’ll find information explaining how the particular family member differs from the standarddefinition in its implementation of the function.

Here’s the differences table:

Table 6 (Page 1 of 2). Interval control—task-related base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CANCEL command

INVREQ condition N N N N N

RETRIEVE command

RTERMID option N N N

RTRANSID option N N N

WAIT option N N N N N

6 API Structure


TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


START command

AT option N N N N

AFTER option N N N N

HOURS option N N N N

MINUTES option N N N N

NOCHECK option N

PROTECT option N



SECONDS option N N N N

USERID option N N N N N N N N N N T N N N N N N N N N N N

LENGERR condition N N N N N N N N N

The differences table uses the convention:

N The command or option or condition is not supported by this memberT The command or option is tolerated; for example, the USERID option is recognized by the OS/2 V3

translator but is ignored during command execution.

You’ll find more information, where relevant, in notes following the differences table.

After the base, we describe each of the towers, using the same structure (description, support table,standard definition table, differences table) as for the base.

How we present the SPI information

The System Programming INQUIRE and SET commands allow you to look at the information that definesa named resource (this includes the installed definition and some run-time values) and to change some ofthe values.

We have divided the INQUIRE and SET commands into the following functional groups:

AUTOINSTALL

AUTINSTMODELAUTOINSTALL

Communications - access method IRCVTAM

Communications - connections CONNECTIONMODENAME

Communications - terminals TERMINALNETNAME

Communications - related PARTNERPROFILE

Functions, bases, and towers 7

Each INQUIRE and SET command has a number of options that describe or define a resource. For someof these options, you define your own value. For example, resource names are generally user-defined.Other options, specifically those that refer to resource status or definition, have values that areCICS-supplied. These values are known as CICS-value data areas (CVDAs).

For each command, we generally provide two tables. The first shows the support for each option. Thesecond shows the support for all CVDA values (if any) associated with each option. Note that theINQUIRE command has a special form that allows you to browse all definitions of certain resource types.The START, NEXT, and END options that control browsing are not included in the option support tables.

Data sets DSNAME

Diagnostic services - dump DUMPDSSYSDUMPCODETRANDUMPCODE

Diagnostic services - trace TRACEDESTTRACEFLAGTRACETYPE

Environment services SYSTEM

Exits EXITPROGRAM

File control FILE

| Journal control| JOURNALMODEL| JOURNALNAME| JOURNALNUM| STREAMNAME|

Monitoring MONITOR

Program control PROGRAM

Queued requests REQID

| Recovery Management| UOW| UOWDSNFAIL| UOWENQ| UOWLINK|

Statistics STATISTICS

Storage STORAGE

Tasks TASKTASK LISTTCLASSTRANCLASS

Temporary storage TSQUEUE

Transactions TRANSACTION

Transient data TDQUEUE

Volumes VOLUME

8 API Structure

Application programming


10 API Structure

abend

Abend handling

Table 7. Abend handling base and towers

┌──────┐

│ │

│ BASE │

│ │

└──────┘

Table 8. Abend handling support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y D D D Y Y Y D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y D D D D D D D D Y Y Y

Base

Abend a transaction, specifying a code to be reported, and intercept transaction abends.

Table 9. Abend handling base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y D D D Y Y Y D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y D D D D D D D D Y Y Y

Table 10. Abend handling base standard definition


ABEND ABCODE�CANCELNODUMP

HANDLE ABEND CANCELLABEL�1

PROGRAM�

RESET

NOTAUTHPGMIDERR

POP HANDLE2 INVREQ

PUSH HANDLE2

Notes:

1. C and PL/I application programs cannot use the LABEL option.


abend

2. The POP HANDLE and PUSH HANDLE commands are used in the context of abend handlingto suspend and restore the current effect of HANDLE ABEND commands.

Table 11. Abend handling base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ABEND command

NODUMP option N N N N N N N N N N

HANDLE ABEND command

NOTAUTH condition N N N N

POP HANDLE command

INVREQ condition N

12 API Structure

appc mapped

Advanced program-to-program communication (APPC)mapped

Notes:

1. This section describes mapped conversations only.2. The CICS base/towers structure does not necessarily coincide with the SNA LU6.2 APPC

base/towers architecture.

Table 12. APPC mapped base and towers

┌───┬───┬───┐

│ A │ A │ A │

│ M │ M │ M │

│ 3 │ 8 │ 1 │

│ │ │ 2 │

├───┴───┴───┤

│ │

│ BASE │

│ │

└───────────┘

AM3 PIP dataAM8 MAXPROCLEN on EXTRACT PROCESSAM12 PARTNER on ALLOCATE

Table 13. APPC mapped support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y D D D D D D D D

AM3 Y Y Y Y Y Y Y Y Y Y Y Y

AM8 Y Y Y Y N N N N N N N N

AM12 Y Y N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base D D D D D D D D D Y D D

AM3 D D D N Y Y Y Y Y D D D

AM8 Y N N N N N N N N Y Y Y

AM12 N N N N N N N N N N N N

Base

Allow transactions to communicate with other programs using an APPC interface.

Table 14. APPC mapped base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y D D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D D D D D D Y D D


appc mapped

Table 15 (Page 1 of 2). APPC mapped base standard definition


ALLOCATE NOQUEUENOSUSPENDPROFILE�STATE�SYSID�

CBIDERRINVREQSYSBUSYSYSIDERR

CONNECT PROCESS1 CONVID�

PROCLENGTH�

PROCNAME�STATE�SYNCLEVEL�

INVREQLENGERRNOTALLOC

CONVERSE CONVID�

FROM�

FROMFLENGTH�

FROMLENGTH�

INTO�

MAXFLENGTH�

MAXLENGTH�

NOTRUNCATESET�STATE�TOFLENGTH��

TOLENGTH��

EOCINVREQLENGERRNOTALLOCSIGNALTERMERR

EXTRACT ATTRIBUTES CONVID�

STATE�INVREQNOTALLOC

EXTRACT PROCESS CONVID�

PROCLENGTH�

PROCNAME�SYNCLEVEL�

INVREQNOTALLOC

FREE CONVID�


ISSUE ABEND CONVID�

STATE�INVREQNOTALLOCTERMERR

ISSUE CONFIRMATION CONVID�


ISSUE ERROR CONVID�

STATE�INVREQNOTALLOCSIGNALTERMERR

ISSUE PREPARE CONVID�


14 API Structure

appc mapped

Table 15 (Page 2 of 2). APPC mapped base standard definition


ISSUE SIGNAL CONVID�


RECEIVE CONVID�

FLENGTH��

INTO�

LENGTH��

MAXFLENGTH�

MAXLENGTH�

NOTRUNCATESET�STATE�

EOCINVREQLENGERRNOTALLOCSIGNALTERMERR

SEND CONFIRMCONVID�

FLENGTH�

FROM�

INVITELASTLENGTH�

STATE�WAIT

INVREQLENGERRNOTALLOCSIGNALTERMERR

WAIT CONVID�


Note: The CICS/ESA products also return the TERMERR condition on the CONNECT PROCESScommand.

Table 16. APPC mapped base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ALLOCATE command

CBIDERR condition 1 1 1 1 1

SYSBUSY condition N 2 2 2 2 2

CONNECT PROCESS command

SYNCLEVEL(2) option N N N N N N

all commands

STATE option N N N N N N N N

Notes:

1. The CBIDERR condition is raised later, during execution of the CONNECT PROCESScommand

2. The SYSBUSY condition is raised later, during execution of the CONNECT PROCESScommand

Advanced program-to-program communication (APPC) mapped 15

appc mapped

PIP data—tower AM3

Send and receive Process Initialization Parameters (PIP data).

Table 17. PIP data tower (AM3) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D N Y Y Y Y Y D D D

Table 18. PIP data tower (AM3) standard definition


CONNECT PROCESS PIPLENGTH�

PIPLIST�LENGERR

EXTRACT PROCESS PIPLENGTH�

PIPLIST�

Table 19. PIP data tower (AM3) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

EXTRACT PROCESS command

PIPLENGTH option T N N N N N

PIPLIST option T N N N N N

16 API Structure

appc mapped

MAXPROCLEN on EXTRACT PROCESS—tower AM8

Extract process names (also known as transaction program names or TPNs) longer than 32 bytes.

Table 20. MAXPROCLEN on EXTRACT PROCESS tower (AM8) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y N N N N N N N N Y Y Y

Table 21. MAXPROCLEN on EXTRACT PROCESS tower (AM8) standard definition


EXTRACT PROCESS MAXPROCLEN� LENGERR

Support PARTNER resource—tower AM12

Establish a conversation with a PARTNER rather than a SYSID.

Table 22. Support PARTNER resource tower (AM12) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

N N N N N N N N N N N N

Table 23. Support PARTNER resource (AM12) standard definition


ALLOCATECONNECT PROCESS

PARTNER� PARTNERIDERR

Advanced program-to-program communication (APPC) mapped 17

appc mapped

18 API Structure

authentication

Authentication

Table 24. Authentication base and towers

┌───┬────┬───┬───┬───┬───┬───┐

│ A │ A │ A │ A │ A │ A │ A │

│ U │ U │ U │ U │ U │ U │ U │

│ 1 │ 1 │ 1 │ 1 │ 2 │ 4 │ 5 │

│ A │ B │ C │ D │ │ │ │

├───┴────┴───┴───┴───┴───┴───┤

│ │

│ BASE │

│ │

└────────────────────────────┘

AU1A Magnetic stripe dataAU1B National language - single characterAU1C National language - three charactersAU1D External security manager (ESM) supportAU2 Query resource accessAU4 Change passwordAU5 Verify password

Table 25. Authentication support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y D D D D D D D

AU1A Y Y Y Y Y N N N N N N N

AU1B Y Y Y Y Y N N N N N N N

AU1C Y Y N N N N N N N N N N

AU1D Y Y N N N N N N N N N N

AU2 Y Y Y Y D N N N N N N N

AU4 Y Y N N N N N N N N N N

AU5 Y Y N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y Y Y D Y D D D D D D D

AU1A N N N N N N N N N N N N

AU1B Y Y Y Y N N N N N N N N

AU1C Y N N N N N N N N N N N

AU1D Y N N N N N N N N N N N

AU2 N N N N N N N N N N N N

AU4 Y N N N N N N N N N N N

AU5 Y N N N N N N N N N N N

Base

The base for the authentication function includes the Security Management services provided either byCICS or by the underlying operating system.

Associate the security capabilities and operator characteristics of a particular userid with the principalfacility, thus assigning the authorities associated with that userid to the facility, through

1. explicit sign on to CICS using the SIGNON command

2. explicit sign on to CICS using either the CESN or the CSSN transactions; for example refer to theCICS for AIX products

3. implicit sign on to CICS with the default CICS userid; for example refer to the CICS/ESA products


authentication

4. explicit sign on to the underlying operating system; for example refer to the CICS/400 products

The security capabilities and operator characteristics of a non-terminal task are established by either theUSERID option on the START command, refer to tower ICK9, or by the equivalent ATI functions inTransient Data.

Table 26. Authentication base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y Y Y D Y D D D D D D D

Table 27. Authentication base standard definition


SIGNOFF INVREQ

SIGNON NEWPASSWORD�

PASSWORD�

USERID�

INVREQNOTAUTH1

USERIDERR

Note: Elsewhere in the API, the NOTAUTH condition means that an application has tried to use afunction for which it is not authorized. In authentication, the NOTAUTH condition means that theuser failed to provide a password (and/or OIDCARD in the AU1A tower).

Support is added to CICS for AIX V2.1.1 by PTF, but is included in the Transaction Server forWindows NT.

Table 28. Authentication base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SIGNOFF

SIGNOFF command N N N N N N N N N N N N N N

CESF transaction N N N

CSSF transaction N N N

SIGNON

SIGNON command N N N N N N N N N N N N N N

NEWPASSWORD option N

CESN transaction N N N

CSSN transaction N N N

20 API Structure

authentication

Magnetic Stripe data—AU1A

Obtain USERID information from a magnetic stripe card.

Table 29. Magnetic Stripe data tower (AU1A) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 30. Magnetic Stripe data (AU1A) standard definition


SIGNON OIDCARD� NOTAUTH

National language - single character—AU1B

Specify the National language, as a 1-character code, to be used for the principal facility.

Table 31. National language - single character tower (AU1B) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 32. National language - single character (AU1B) standard definition


SIGNON NATLANG�

NATLANGINUSE�INVREQ

Authentication 21

authentication

National language - three character—AU1C

Specify the National language, as a 3-character code, to be used for the principal facility.

Table 33. National language - three character tower (AU1C) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y N N N N N N N N N N N

Table 34. National language - three character (AU1C) standard definition


SIGNON LANGUAGECODE�LANGINUSE�

INVREQ

External Security Manager (ESM) Support—AU1D

Exploit function provided by an External Security Manager (ESM) which supports the SAF standardinterface.

Table 35. External Security Manager (ESM) Support tower (AU1D) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 36. External Security Manager (ESM) Support (AU1D) standard definition


SIGNON ESMREASON�

ESMRESP�GROUPID�

NOTAUTHINVREQ

22 API Structure

authentication

Query Resource Access—AU2

Query access to resources controlled by an External Security Manager (ESM).

The ESM should support the SAF Standard Interface.

Table 37. Query Resource Access tower (AU2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y D N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 38. Query Resource Access (AU2) standard definition


QUERY SECURITY ALTER�

CONTROL�LOGMESSAGE�READ�

RESCLASS�RESID�

RESIDLENGTH�

RESTYPE�UPDATE�

INVREQLENGERRNOTFNDQIDERR

Table 39. Query Resource Access options tower (AU2) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

QUERY SECURITY command

ALTER option N

CONTROL option N

LOGMESSAGE option N

RESCLASS option N

RESIDLENGTH option N

Authentication 23

authentication

Change Password—AU4

Unlike the SIGNON command, the CHANGE PASSWORD command does not depend upon the prinicipalfacility, so it can be used by a non terminal task.


Table 40. Change Password tower (AU4) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 41. Change Password (AU4) standard definition


CHANGE PASSWORD ESMREASON�

ESMRESP�NEWPASSWORD�

PASSWORD�

USERID�

INVREQNOTAUTHUSERIDERR

Verify Password—AU5

Unlike the SIGNON command, the VERIFY PASSWORD command does not depend upon the prinicipalfacility, so it can be used by a non terminal task.


Table 42. Verify Password tower (AU5) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


24 API Structure

authentication

Table 43. Verify Password (AU5) standard definition


VERIFY PASSWORD CHANGETIME�DAYSLEFT�ESMREASON�

ESMRESP�EXPIRYTIME�INVALIDCOUNT�LASTUSETIME�PASSWORD�

USERID�

INVREQNOTAUTHUSERIDERR

Authentication 25

authentication

26 API Structure

bms

BMS

Basic mapping support (BMS) has long been divided into minimum, standard, and full functions. Thisgoes back to the days when storage was scarce, and CICS system programmers needed every help tooptimize its use. Storage is now less of an issue because:

� On large mainframes, we have 31-bit architectures.� On platforms such as CICS OS/2 and CICS/6000, storage constraint is not a problem.

We have not distinguished between minimum, standard, and full function BMS in developing the base andtower model for BMS.

We’ve developed different models for the two distinct parts of the BMS API:

1. The application programming interface2. The map definition interface

The BMS application programming interface

Logically, the BMS application programming interface divides into four distinct functional areas:

� Receive field-oriented data (for example, RECEIVE MAP)� Send control information (for example, SEND CONTROL)� Send field-oriented data (for example, SEND MAP)� Send non-field-oriented data (for example, SEND TEXT)

The BMS1 towers build directly on those four areas. Two general services towers, cumulative mappingand paging, provide additional function across the areas. The three BMS3 towers build on the pagingfunction, and finally, tower BMS4A adds to the time support in tower BMS3A. Table 44 shows the baseand tower relationships graphically.

Table 44. BMS application programming interface base and towers

┌───────────┐

│ BMS4A │

└───────────┘

┌───────────┐ ┌────────┐ ┌────────┐

│ │ │ BMS3B │ │ BMS3C │

│ BMS3A ┌───┘ └────────┘ └────────┘

│ │┌──────────────────────────┐

└───────┘└────┐ │

┌───────────┐ │ BMS2B │

│ BMS2A │ │ │

└───────────┘ └─────────────────────┘

┌─────┐ ┌───┬───┬───┬───┬───┬───┬───┐

│ │ │ 1 │ 1 │ 1 │ 1 │ 1 │ 1 │ 1 │

│ │ │ A │ B │ C │ D │ E │ F │ H │

│ │ └───┴───┴───┴───┴───┴───┴───┘

│ └──────────────────────┬──────┐

│ BASE │ BMS1 │

└────────────────────────────┴──────┘

BMS1 Send device dependent dataBMS1A Partition-oriented dataBMS1B SEND CONTROL extensionsBMS1C Send field-oriented data extensionsBMS1D Send non-field-oriented data extensionsBMS1E Receive field-oriented data extensionsBMS1F SCS printer supportBMS1H Select ERASE screensizeBMS2A Cumulative mappingBMS2B PagingBMS3A RoutingBMS3B RecoveryBMS3C Pseudoconversation supportBMS4A Additional time support


bms

Table 45. BMS application programming interface support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y D D D D Y Y Y D

BMS1 Y Y Y Y Y Y Y Y Y Y Y Y

BMS1A Y Y Y Y Y Y Y D Y Y Y D

BMS1B Y Y Y Y Y Y Y Y Y Y Y Y

BMS1C Y Y Y Y Y Y Y Y Y Y Y Y

BMS1D Y Y Y Y Y Y Y Y Y Y Y Y

BMS1E Y Y Y Y Y Y Y Y Y Y Y Y

BMS1F Y Y Y Y Y Y Y Y Y Y Y Y

BMS1H Y Y N N N N N N Y N N N

BMS2A Y Y Y Y Y D D D Y Y Y D


BMS3A Y Y Y Y Y Y Y Y Y Y Y Y


BMS3C Y Y Y Y Y Y Y Y Y Y Y Y

BMS4A Y Y Y Y Y N N N Y Y Y N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


BMS1 N N N N N N N N N N N N

BMS1A N N N N N N N N N N N N

BMS1B N N N N N N N N N N N N

BMS1C N N N N N N N N N N N N

BMS1D N N N N N N N N N N N N

BMS1E N N N N N N N N N N N N

BMS1F D D D D D D D D D D D D

BMS1H Y N N N N N N N N N N N





BMS3C N N N N N N N N N N N N


28 API Structure

bms

The BMS application programming base

Send and receive mapped data and text to and from a 3270 terminal, and do some simple controlfunctions at the terminal.

Table 46. BMS application programming base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y D D D D Y Y Y D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 47 (Page 1 of 2). BMS application programming base standard definition


RECEIVE MAP ASISFROM�1

INTO�

LENGTH�

MAPSET�SET�TERMINAL

INVMPSZINVREQMAPFAIL

SEND CONTROL ALARMCURSOR�

ERASEERASEAUPFORMFEEDFREEKBFRSETHONEOMLASTLDC�

L40L64L80MSR�

PRINTWAIT

IGREQCDINVLDCINVREQWRBRK

BMS 29

bms

Table 47 (Page 2 of 2). BMS application programming base standard definition


SEND MAP ALARMCURSOR�

DATAONLYERASEERASEAUPFORMFEEDFREEKBFROM�1

FRSETLENGTH�

MAPONLYMAPSET�PRINTWAIT

INVMPSZINVREQ

SEND TEXT ALARMCURSOR�

ERASEFORMFEEDFREEKBFROM�1

LENGTH�

PRINTWAIT

INVREQLENGERR

Note: CICS/400 V2.3 also returns NOTAUTH on SEND MAP and RECEIVE MAP.

Table 48 (Page 1 of 2). BMS application programming base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

RECEIVE MAP command

INVMPSZ condition N

INVREQ condition N

SEND CONTROL command

FORMFEED option N N N N

FREEKB option T T T T

HONEOM option N N N N N N N N N N N N

L40 option N N N N N N N N N N N N




SEND MAP command

FREEKB option T T T T


FORMFEED option N N N N

SEND TEXT command

30 API Structure

bms

Table 48 (Page 2 of 2). BMS application programming base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

LENGERR condition N N N N N

Send device dependent data—tower BMS1

Send a page of device dependent data-stream built by the application program.

Table 49. Send device dependent data-stream (BMS1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 50. Send device dependent data tower (BMS1) standard definition


SEND TEXT NOEDIT ALARMERASEFREEKBFROM�

LENGTH�

PRINT

INVREQ

Partition-oriented data—tower BMS1A

Send and receive data to and from partitioned displays.

Table 51. Partition-oriented data tower (BMS1A) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y Y Y D Y Y Y D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


BMS 31

bms

Table 52. Partition-oriented data tower (BMS1A) standard definition


RECEIVE MAP INPARTN� INVPARTNPARTNFAIL

RECEIVE PARTN ASISINTO�

LENGTH��

SET�

INVPARTNINVREQLENGERR

SEND CONTROLSEND MAP

ACTPARTN�

OUTPARTN�

INVPARTN

SEND PARTNSET INVPARTNSETINVREQ

SEND TEXT ACTPARTN�

OUTPARTN�

INVPARTN

SEND TEXT NOEDIT OUTPARTN� INVPARTNINVREQ

Table 53. Partition-oriented data—tower(BMS1A) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

RECEIVE PARTN command

INVREQ condition N N

SEND CONTROL extensions—tower BMS1B

Provide additional support for “send control information”, including logical device code (LDC) devices andmagnetic stripe readers.

Table 54. SEND CONTROL extensions tower (BMS1B) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


32 API Structure

bms

Table 55. SEND CONTROL extensions tower (BMS1B) standard definition


SEND CONTROL LASTLDC�

MSR�

IGREQCDINVLDCWRBRK

Send field-oriented data extensions—tower BMS1C

Provide additional support for “send field-oriented data”, including logical device code (LDC) devices andmagnetic stripe readers.

Table 56. Send field-oriented data extensions tower (BMS1C) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 57. Send field-oriented data extensions tower (BMS1C) standard definition


SEND MAP FMHPARM�

HONEOMLASTLDC�

L40L64L80MSR�


SEND PAGE ALLCURRENTFMHPARM�

LAST

IGREQCD

BMS 33

bms

Send non-field-oriented data extensions—tower BMS1D

Provide additional support for “send non-field-oriented data”, including logical device code (LDC) devicesand magnetic stripe readers.

Table 58. Send non-field oriented data extensions tower (BMS1D) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 59. Send non-field-oriented data extensions tower (BMS1D) standard definition


SEND TEXT HONEOMLASTLDC�

L40L64L80MSR�


SEND TEXT MAPPED LASTWAIT

IGREQCDWRBRK

SEND TEXT NOEDIT HONEOMLASTL40L64L80WAIT

IGREQCDINVREQWRBRK

Receive field-oriented data extensions—tower BMS1E

Provide additional support for devices other than 3270s.

Table 60. Receive field-oriented data extensions tower (BMS1E) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


34 API Structure

bms

Table 61. Receive field-oriented data extensions tower (BMS1E) standard definition


RECEIVE MAP EOCEODSRDATTUNEXPIN

RECEIVE PARTN EOCEODS

SCS printer support—tower BMS1F

Provide the NLEOM option, to support SCS printers.

Table 62. SCS printer support tower (BMS1F) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 63. SCS printer support tower (BMS1F) standard definition


SEND MAPSEND TEXT

NLEOM

Table 64. SCS printer support—tower(BMS1F) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SEND MAP command

NLEOM option N N N N N N N N N N N N

BMS 35

bms

Select ERASE screensize—BMS1H

Allow selection of screensize for ERASE option.

Table 65. Select ERASE screensize tower (BMS1H) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y N N N N N N Y N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 66. Select ERASE screensize (BMS1H) standard definition


SEND CONTROLSEND MAPSEND TEXT

ALTERNATEDEFAULT

Cumulative mapping—tower BMS2A

Build a logical message from a series of SEND commands.

Table 67. Cumulative mapping tower (BMS2A) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 68 (Page 1 of 2). Cumulative mapping tower (BMS2A) standard definition


PURGE MESSAGE

SEND CONTROL ACCUMTERMINAL | SET�

RETPAGE

SEND MAP ACCUMNOFLUSHTERMINAL | SET�

OVERFLOWRETPAGE

SEND PAGE SET�TRAILER

RETPAGE

36 API Structure

bms

Table 68 (Page 2 of 2). Cumulative mapping tower (BMS2A) standard definition


SEND TEXT ACCUMHEADER�

JUSFIRSTJUSLASTJUSTIFY�TERMINAL | SET�TRAILER�

RETPAGE

SEND TEXT MAPPED FROM�

LENGTH�

TERMINAL

INVREQ

Table 69. Cumulative mapping—tower(BMS1A) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SEND MAP command

NOFLUSH option N N N N

Paging support—tower BMS2B

Store the device-dependent data stream built by BMS in CICS temporary storage for subsequent retrievalby an operator using the terminal operator paging transaction.

Table 70. Paging support tower (BMS2B) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 71 (Page 1 of 2). Paging support tower (BMS2B) standard definition


PURGE MESSAGE TSIOERR

SEND CONTROLSEND MAP

PAGINGREQID

IGREQIDTSIOERR

BMS 37

bms

Table 71 (Page 2 of 2). Paging support tower (BMS2B) standard definition


SEND PAGE AUTOPAGENOAUTOPAGEOPERPURGERELEASERETAIN

IGREQIDINVREQTSIOERR

SEND TEXTSEND TEXT MAPPEDSEND TEXT NOEDIT

PAGINGREQID

IGREQIDTSIOERR

38 API Structure

bms

Routing support—tower BMS3A

Send a logical message to a number of terminals.

Table 72. Routing support tower (BMS3A) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 73. Routing support tower (BMS3A) standard definition


ROUTE ERRTERM�

INTERVAL�LDC�

LIST�NLEOMOPCLASS�TIME�TITLE�

INVERRTERMINVLDCINVREQRTEFAILRTESOME

Recovery—tower BMS3B

Recover a BMS logical message.

Table 74. Recovery tower (BMS3B) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 75. Recovery tower (BMS3B) standard definition


ROUTE REQID�

SEND CONTROLSEND MAPSEND TEXTSEND TEXT MAPPEDSEND TEXT NOEDIT

REQID� IGREQIDTSIOERR

BMS 39

bms

Pseudoconversation support—tower BMS3C

Add BMS function to enable pseudoconversational programs.

Table 76. Pseudoconversation support tower (BMS3C) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 77. Pseudoconversation support tower (BMS3C) standard definition


SEND PAGE TRANSID� INVREQ

Time—tower BMS4A

Specify the time at which a logical message is to be sent to a number of terminals. This tower is requiredfor C language programs, which cannot use the INTERVAL and TIME options, which expect packeddecimal values.

Table 78. Time tower (BMS4A) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y N N N Y Y Y N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 79. Time tower (BMS4A) standard definition


ROUTE AFTERATHOURS�MINUTES�SECONDS�

INVREQ

40 API Structure

bms

The BMS map definition interface

The BMS map definition interface consists of a set of macros and associated operands (keywords andarguments). Most of this part of the BMS API is implemented on every platform, and the base function iscorrespondingly large.

There are four functional towers:

1. Support for special types of device2. Support for cumulative mapping3. Support for programming languages4. Support for cursor location

The model for the interface is therefore:

Table 80. BMS map definition interface base and towers

┌───┬───┬───┬───┐

│ B │ B │ B │ B │

│ M │ M │ M │ M │

│ S │ S │ S │ S │

│ M │ M │ M │ M │

│ D │ D │ D │ D │

│ 1 │ 1 │ 1 │ 1 │

│ A │ B │ C │ D │

├───┴───┴───┴───┤

│ │

│ BASE │

│ │

└───────────────┘

BMSMD1A Device supportBMSMD1B Cumulative mappingBMSMD1C Programming language supportBMSMD1D Cursor location

In the descriptions of the BMS map definition interface base and towers that follow, you’ll see that we’veused a different format from that in the rest of the book. This reflects:

� The nature of the interface itself: a macro, rather than a command, interface

� The extra granularity needed when describing support for the towers.

There’s no “BMS map definition interface support” table, showing the support for the whole interface.Instead, for the base function, we’ve used a format similar to the rest of the book, but used a style ofstandard definition table more suited to describing macros.

For the towers, we’ve provided a series of support tables, dividing each tower by macro (DFHMSD,DFHMDI, and so on), and showing which family members support which keywords, followed by adifferences table for every D in the support tables.

The BMS map definition interface base

Specify a wide range of characteristics for physical and symbolic maps.

Table 81. BMS map definition interface base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


BMS 41

bms

Table 82. BMS map definition interface base standard definition

Macros Operands

DFHMSD [,BASE=name}[,COLOR={DEFAULT | color}][,CTRL=([PRINT] [,length] [,FREEKB] [,ALARM] [,FRSET])][,DSATTS=(attr1,attr2,...)][,EXTATT={NO | MAPONLY | YES}][,HILIGHT={OFF | BLINK | REVERSE | UNDERLINE}][,MAPATTS=(attr1,attr2,...)][,MODE={IN | OUT | INOUT}][,OUTLINE={BOX | ([LEFT] [,RIGHT] [,OVER] [,UNDER])}][,SOSI={NO | YES}][,STORAGE={AUTO}][,SUFFIX=number][,TERM=type}[,TIOAPFX={YES | NO}][,TRANSP={YES | NO}]TYPE={DSECT | FINAL | MAP}

DFHMDI [,COLOR={DEFAULT | color}][,COLUMN=number][,CTRL=([PRINT] [,length] [,FREEKB] [,ALARM] [,FRSET])][,DSATTS=(attr1,attr2,...)][,EXTATT={NO | MAPONLY | YES}][,FIELDS=NO][,HILIGHT={OFF | BLINK | REVERSE | UNDERLINE}][,JUSTIFY=BOTTOM][,LINE=number][,MAPATTS=(attr1,attr2,...)][,OUTLINE={BOX | ([LEFT] [,RIGHT] [,OVER] [,UNDER])}][,SIZE=(line,column)][,SOSI={NO | YES}][,TIOAPFX={YES | NO}][,TRANSP={YES | NO}]

DFHMDF [,ATTRB=([{ASKIP | PROT | UNPROT[,NUM]}] [,{BRT | NORM | DRK}][,DET] [,IC] [,FSET])][,CASE=MIXED][,COLOR={DEFAULT | color}][,GRPNAME=group-name][,HILIGHT={OFF | BLINK | REVERSE | UNDERLINE}][,INITIAL='char data' | XINIT='hex data'][,JUSTIFY=([{LEFT | RIGHT}] [,{BLANK | ZERO}])][,LENGTH=number][,OCCURS=number][,OUTLINE={BOX | ([LEFT] [,RIGHT] [,OVER] [,UNDER])}][,PICIN='value'][,PICOUT='value'][,POS={number | (line,column)}][,SOSI={NO | YES}][,TRANSP={YES | NO}]

42 API Structure

bms

Table 83. BMS map definition interface base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DFHMDF macro

TRANSP operand N N N N T T T

DFHMDI macro

FIELDS operand N N N N

LINE operand N N N

TIOAPFX=NO operand N N N N N N N N

TIOAPFX=YES operand N N N


DFHMSD macro

BASE operand N

SUFFIX operand N N N N

TIOAPFX=NO operand N N N N N


Device support—tower BMSMD1A

Support special types of device, including partitioned displays. Also support DATA, which defines howBMS handles data in the host environment.

Table 84 (Page 1 of 2). Device support tower (BMSMD1A)—DFHMSD macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

DATA Y Y Y Y Y Y Y Y Y Y Y Y

FLDSEP Y Y Y Y Y Y Y Y Y Y Y Y

HTAB Y Y Y Y Y Y Y Y Y Y Y Y

KEXTATT Y Y Y Y Y Y Y N Y Y Y N

LDC Y Y Y Y Y Y Y Y Y Y Y Y

OBFMT Y Y Y Y Y Y Y Y Y Y Y Y

PARTN Y Y Y Y Y Y Y Y Y Y Y Y

PS Y Y Y Y Y Y Y Y Y Y Y Y

VALIDN Y Y Y Y Y Y Y Y Y Y Y Y

VTAB Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

DATA N N N N N N N N N N N N

FLDSEP N N N N N N N N N N N N

HTAB N N N N N N N N N N N N

KEXTATT Y Y Y Y N N N N N Y Y Y

LDC N N N N N N N N N N N N

OBFMT N N N N N N N N N N N N

PARTN N N N N D D D D D N N N

PS Y Y Y Y N N N N N Y Y Y

BMS 43

bms

Table 84 (Page 2 of 2). Device support tower (BMSMD1A)—DFHMSD macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

VALIDN Y Y Y Y D D D D D Y Y Y

VTAB N N N N N N N N N N N N

Table 85. Device support tower (BMSMD1A)—DFHMDI macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

DATA Y Y Y Y Y Y Y Y Y Y Y Y

FLDSEP Y Y Y Y Y Y Y Y Y Y Y Y

KEXTATT Y Y Y Y N N N N Y Y Y N

LDC Y Y Y Y Y Y Y Y Y Y Y Y

OBFMT Y Y Y Y Y Y Y Y Y Y Y Y

PARTN Y Y Y Y Y Y Y Y Y Y Y Y


TERM Y Y Y Y N N N N N N N N


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

DATA N N N N N N N N N N N N

FLDSEP N N N N N N N N N N N N

KEXTATT Y Y Y Y N N N N N Y Y N

LDC N N N N N N N N N N N N

OBFMT N N N N N N N N N N N N

PARTN N N N N N N N N N N N N

PS N N N N N N N N N N N N

TERM N N N N N N N N N N N N


Table 86. Device support tower (BMSMD1A)—DFHMDF macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

GINIT Y Y Y Y N N N N N N N N



OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

GINIT N N N N D D D D D Y Y N

PS Y Y Y Y D D D D D Y Y Y


44 API Structure

bms

Table 87. Device support tower (BMSMD1A)—DFHPSD macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

ALTSCRN Y Y Y Y Y Y Y Y Y Y Y Y

CHARSIZE Y Y Y Y Y Y Y Y Y Y Y Y

SUFFIX Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

ALTSCRN N N N N N N N N N N N N

CHARSIZE N N N N N N N N N N N N

SUFFIX N N N N N N N N N N N N

Table 88. Device support tower (BMSMD1A)—DFHPDI macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

ATTRB Y Y Y Y Y Y Y Y Y Y Y Y

BUFSZE Y Y Y Y Y Y Y Y Y Y Y Y

CHARSZE Y Y Y Y Y Y Y Y Y Y Y Y

MAPSFX Y Y Y Y Y Y Y Y Y Y Y Y

VIEWPOS Y Y Y Y Y Y Y Y Y Y Y Y

VIEWSZE Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

ATTRB N N N N N N N N N N N N

BUFSZE N N N N N N N N N N N N

CHARSZE N N N N N N N N N N N N

MAPSFX N N N N N N N N N N N N

VIEWPOS N N N N N N N N N N N N

VIEWSZE N N N N N N N N N N N N

Table 89. Device support—tower (BMSMD1A) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DFHMDF macro

PS operand, not PS=8 N N N N N

DFHMDI macro


DFHMSD macro


BMS 45

bms

Cumulative mapping—tower BMSMD1B

Support cumulative mapping.

Table 90. Cumulative mapping tower (BMSMD1B)—DFHMDI macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

COLUMN Y Y Y Y Y Y Y Y Y Y Y Y

HEADER Y Y Y Y Y Y Y Y Y Y Y Y

JUSTIFY Y Y Y Y Y Y Y Y Y Y Y Y

LINE Y Y Y Y Y Y Y Y Y Y Y Y

TRAILER Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

COLUMN D D D D D D D D D D D D

HEADER N N N N N N N N N N N N

JUSTIFY Y Y Y D D D D D D D D D

LINE D D D D D D D D D D D D

TRAILER N N N N N N N N N N N N

Table 91. Cumulative mapping—tower (BMSMD1B) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DFHMDI macro

COLUMN=NEXT operand N N N N N N N N N N N N

COLUMN=SAME operand N N N N N N N N N N N N

JUSTIFY=FIRST operand N N N N N N N N N

JUSTIFY=LAST operand N N N N N N N N N

JUSTIFY=LEFT operand N N N N N N N N N

JUSTIFY=RIGHT operand N N N N N N N N N

LINE=NEXT operand N N N N N N N N N N N N

LINE=SAME operand N N N N N N N N N N N N

46 API Structure

bms

Programming language support—tower BMSMD1C

Support programming languages.

Table 92. Programming language support tower (BMSMD1C)—DFHMSD macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

FOLD Y Y Y Y Y N N N Y Y N N

LANG=ASM Y Y Y Y Y Y Y Y Y Y Y Y

LANG=C Y Y Y Y Y N N N Y Y Y N

LANG=COBOL Y Y Y Y Y Y Y Y Y Y Y Y

LANG=PLI Y Y Y Y Y Y Y Y Y Y Y Y

LANG=RPG N N N N N N N N Y Y Y Y

TRIGRAPH1 Y Y Y Y Y N N N Y Y N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

FOLD N N N N N N N N N Y Y Y

LANG=ASM N N N N N N N N N N N N

LANG=C Y Y Y Y Y Y Y Y Y N N N

LANG=COBOL Y Y Y Y Y Y Y Y Y N N N

LANG=PLI Y Y N N N N N N N N N N

LANG=RPG N N N N N N N N N N N N

TRIGRAPH1 N N N N N N N N N N N N

Note: The TRIGRAPH keyword is spelled TRIGRAF in the CICS/VSE products.

Table 93. Programming language support tower (BMSMD1C)—DFHMDI macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

BASE Y Y Y Y N N N N Y Y N N

LANG=ASM Y Y Y Y N N N N Y Y N N

LANG=C Y Y Y Y N N N N Y Y N N

LANG=COBOL Y Y Y Y N N N N Y Y N N

LANG=PLI Y Y Y Y N N N N Y Y N N

MODE Y Y Y Y N N N N Y Y N N

TYPE Y Y Y Y N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

BASE N N N N N N N N N N N N

LANG=ASM N N N N N N N N N N N N

LANG=C N N N N N N N N N N N N

LANG=COBOL N N N N N N N N N N N N

LANG=PLI N N N N N N N N N N N N

MODE N N N N N N N N N N N N

TYPE N N N N N N N N N N N N

BMS 47

bms

Cursor location—tower BMSMD1D

Return cursor indicator to application.

Table 94. Cursor location tower (BMSMD1D)—DFHMSD macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

CURSLOC Y Y Y Y N N N N Y Y N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

CURSLOC N N N N N N N N N N N N

Table 95. Cursor location tower (BMSMD1D)—DFHMDI macro support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

CURSLOC Y Y Y Y N N N N Y Y N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

400 2.2

CURSLOC N N N N N N N N N N N N

48 API Structure

diagnostic services—dump

Diagnostic services—dump

Table 96. Diagnostic services—dump base and towers

┌──────┐

│ │

│ DU4 │

│ │

├──────┤

│ │

│ BASE │

│ │

└──────┘

DU4 DUMP SYSTEM

Table 97. Diagnostic services—dump support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y D D D Y D D D

DU4 1 1 1 Y Y N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y D D D D D D D D D D D

DU4 N N N N N N N N N N N N

Base

Request a transaction dump.

Table 98. Diagnostic services—dump base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y D D D D D D D D D D D



Table 99. Diagnostic services—dump base standard definition


DUMP1 DUMPCODE� COMPLETEFLENGTH�

FROM�

LENGTH�

PROGRAMSTORAGETASKTERMINAL DCTFCTPCTPPTSITTABLESTCT

DUMP TRANSACTION DUMPCODE�DUMPID�

COMPLETEFLENGTH�

FROM�

LENGTH�

LENGTHLIST�NUMSEGMENTS�PROGRAMSEGMENTLIST�STORAGETASKTERMINAL DCTFCTPCTPPTSITTABLESTCTTRT

INVREQIOERRNOSPACENOSTGNOTOPENOPENERRSUPPRESSED

Note: The DUMP TRANSACTION command should be used in preference to the DUMP command whichis included in the base solely for migration.

50 API Structure


Table 100. Diagnostic services—dump support base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DUMP command

command N N N

DUMP TRANSACTION command

command N N N N N N N N N N N N N N

DUMPID option N N N

COMPLETE option N N N

FLENGTH option N N N

FROM option N N N

LENGTH option N N N

LENGTHLIST option N N N

NUMSEGMENTS option N N N

PROGRAM option N N N

SEGMENTLIST option N N N

STORAGE option N N N

TASK option N N N

TERMINAL option N N N

DCT option N N N

FCT option N N N

PCT option N N N

PPT option N N N

SIT option N N N

TABLES option N N N

TCT option N N N

TRT option N N N

DUMP SYSTEM—tower DU4

Request a CICS system dump.

Table 101. DUMP SYSTEM tower (DU4) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

1 1 1 Y Y N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Notes:

1. The PERFORM DUMP command replaces the DUMP SYSTEM command.2. The DUMP SYSTEM command remains object-code compatible, but not source-code

compatible.

Diagnostic services—dump 51


Table 102. DUMP SYSTEM tower (DU4) standard definition


DUMP SYSTEM CALLER�

CALLERLENGTH�

DUMPCODE�DUMPID�

TITLE�TITLELENGTH�

INVREQIOERRNOSPACENOSTGSUPPRESSEDSYSBUSY

52 API Structure

diagnostic services—trace

Diagnostic services—trace

Table 103. Diagnostic services—trace base and towers

┌──────┐

│ │

│ TR3 │

│ │

├──────┤

│ │

│ BASE │

│ │

└──────┘

TR3 Alternative tracing command

Table 104. Diagnostic services—trace support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y D D N N N D N N N

TR3 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y N N N N N N N N D D D

TR3 D D D D Y Y Y Y Y N N N

Base

Write user trace table entries using ENTER TRACENUM.

Table 105. Diagnostic services—trace base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y D D N N N D N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y N N N N N N N N D D D

Table 106. Diagnostic services—trace base standard definition


ENTER TRACENUM EXCEPTIONFROM�

FROMLENGTH�

RESOURCE�

INVREQLENGERR



Table 107. Diagnostic services—trace base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENTER TRACENUM command

EXCEPTION option N N N N N

FROMLENGTH option N

Alternative tracing command—tower TR3

Write user trace table entries using ENTER TRACEID and TRACE.

Table 108. Alternative tracing command tower (TR3) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D Y Y Y Y Y N N N

Notes:

1. The CICS/390 products support the API in the tower for migration only.2. CICS/400 does not support the tower, but uses the ENTER TRACENUM command (for

ENTER TRACEID) and the SET TRACETYPE command (for TRACE) to provide the equivalentfunction.

Table 109. Alternative tracing command tower (TR3) standard definition


ENTER TRACEID FROM�

RESOURCE�INVREQ

TRACE EIOFFONSINGLESYSTEMUSER

Table 110 (Page 1 of 2). Alternative tracing command tower (TR3) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TRACE command

54 API Structure

d

iagn

ostic services—

trace

Table 110 (P

age 2 of 2). Alternative

tracingcom

mand

tower

(TR

3)differences

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

com

mand

NN

NN

Diagnostic services—

trace55


56 API Structure

environment services

Environment services

Table 111. Environment services base and towers

┌───┬───┬───┐

│ A │ A │ A │

│ D │ D │ D │

│ 2 │ 3 │ 4 │

├───┴───┴───┤

│ │

│ BASE │

│ │

└───────────┘

AD2 Macro coexistenceAD3 SecurityAD4 Set

Table 112. Environment services support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


AD2 D D D D Y Y Y Y Y Y Y Y

AD3 Y Y Y Y N N N N N N N N

AD4 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y Y Y Y D D D D D Y Y Y

AD2 Y Y Y Y N N N N N N N N

AD3 N N N N N N N N N N N N

AD4 N N N N N N N N N N N N

Base

Get access to CICS storage areas.

Note: You may have to serialize update access to fields in the CWA as not all platforms supportquasi-reentrancy.

Some platforms have both a user EIB and a system EIB.

Table 113. Environment services base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y Y Y Y D D D D D Y Y Y



Table 114. Environment services base standard definition


ADDRESS COMMAREA�CWA�EIB�TCTUA�TWA�

| Table 115. Emvironment services—trace base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ADDRESS command

COMMAREA option N N N N 1 1 1 1 1

Note:

1. Supported only for C language programs.

Macro coexistence—tower AD2

Get access to the CSA.

Note: If you’re using the ADDRESS CSA command to access fields in internal control blocks then you’reusing an interface that returns the address of a control block whose format is platform specific andis liable to change from release to release.

The INQUIRE and SET commands provide equivalent function in a platform and releaseindependent manner.

Table 116. Macro coexistence tower (AD2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

D D D D Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 117. Macro coexistence tower (AD2) standard definition


ADDRESS CSA�

58 API Structure


| Table 118. Macro coexistence tower (AD2) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ADDRESS command

CSA option 1 1 1 1

Note:

1. Supported only for migration. An abend occurs if the application program uses the pointerreturned by the command.

Security—tower AD3

Get access to the ACEE security control block.

Table 119. Security tower (AD3) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 120. Security tower (AD3) standard definition


ADDRESS ACEE�

Set—tower AD4

Set the address of a structure or pointer for COBOL applications.

Table 121. Set tower (AD4) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Environment services 59


Table 122. Set tower (AD4) standard definition


ADDRESS SET�USING�

60 API Structure


The ASSIGN command

The ASSIGN command is different from most other CICS API commands. You use it to get values fromoutside an application program’s local environment, and it consists of a list of options, defining the valuesyou can get.

Rather than attempt to try to divide it into a base and towers, we’ve provided just a support table, showingwhich CICS family members support each option. And we’ve put it here, at the end of “EnvironmentServices,” because that’s where it most logically belongs.

Table 123 (Page 1 of 3). ASSIGN option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ABCODE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

ABDUMP Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

ABPROGRAM Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

ALTSCRNHT Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

ALTSCRNWD Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

APLKYBD Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

APLTEXT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

APPLID Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

ASRAINTRPT Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

ASRAKEY Y Y N N N N N N N N N N Y N N N N N N N N N N N

ASRAPSW Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

ASRAREGS Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

ASRASPC Y Y N N N N N N N N N N Y N N N N N N N N N N N

ASRASTG Y Y N N N N N N N N N N Y N N N N N N N N N N N

BTRANS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y

CMDSEC Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

COLOR Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

CWALENG Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

DEFSCRNHT Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

DEFSCRNWD Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

DELIMITER Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DESTCOUNT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DESTID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DESTIDLENG Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DSSCS Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

DS3270 Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

EWASUPP Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

EXTDS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

FACILITY Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

FCI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

GCHARS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

GCODES Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

GMMI Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

HILIGHT Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

INITPARM Y Y Y Y N N N N N N N N Y N N N N N N N N N N N




Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

INITPARMLEN Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

INPARTN Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

INVOKINGPROGRAM Y Y N N N N N N Y N N N Y N N N N N N N N N N N

KATAKANA Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

LANGINUSE Y Y N N N N N N N N N N N N N N N N N N N N N N

LDCMNEM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

LDCNUM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

MAPCOLUMN Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

MAPHEIGHT Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

MAPLINE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

MAPWIDTH Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

MSRCONTROL Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

NATLANGINUSE Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

NETNAME Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

NEXTTRANSID Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

NUMTAB Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

OPCLASS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OPERKEYS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

OPID Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OPSECURITY Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

ORGABCODE Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

OUTLINE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

PAGENUM Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

PARTNPAGE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

PARTNS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

PARTNSET Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

PRINSYSID Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

PROGRAM Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

PS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

QNAME Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

RESSEC Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

RESTART Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y Y Y Y Y

RETURNPROG Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SCRNHT Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

SCRNWD Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

SIGDATA Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

SOSI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

STARTCODE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

STATIONID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

SYSID Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

TASKPRIORITY Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N

TCTUALENG Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

TELLERID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

TERMCODE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

TERMPRIORITY Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

62 API Structure



Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TEXTKYBD Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

TEXTPRINT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

TRANPRIORITY Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

TWALENG Y Y Y Y Y Y N N Y N N Y Y Y Y Y Y Y Y Y Y Y Y Y

UNATTEND Y Y Y Y Y Y N N Y N N Y Y Y Y Y Y Y Y Y Y Y Y Y

USERID Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

USERNAME Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

USERPRIORITY Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

VALIDATION Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y



64 API Structure

exception handling

Exception handling

Table 124. Exception handling base and towers

┌───────┐

│ C │

│ H │

│ 2 │

├───────┤

│ │

│ BASE │

│ │

└───────┘

CH2 Condition handling

Table 125. Exception handling support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y Y Y Y Y Y Y Y

CH2 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


CH2 Y Y Y D Y Y Y Y Y Y Y Y

Base

Test whether command execution raised an exceptional condition.

Table 126. Exception handling base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 127. Exception handling base standard definition


any RESPRESP2NOHANDLE


exception handling

Condition handling—tower CH2

Branch to an error routine if an exceptional condition occurs, ignore an exceptional condition.

Suspend and restore the current effect of HANDLE CONDITION and IGNORE CONDITION commands.

Table 128. Condition handling tower (CH2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y Y Y D Y Y Y Y Y Y Y Y

Table 129. Condition handling tower (CH2) standard definition


HANDLE CONDITION condition�

IGNORE CONDITION condition�

POP HANDLE INVREQ

PUSH HANDLE

Notes:

1. POP HANDLE and PUSH HANDLE relate to the effect on HANDLE CONDITION and IGNORECONDITION.

2. HANDLE CONDITION, IGNORE CONDITION, POP HANDLE, and PUSH HANDLE are notsupported for C programs.

Table 130. Condition handling tower (CH2) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

POP HANDLE command

INVREQ condition N

66 API Structure

file control

File control

Table 131. File control base and towers

┌───┬───┬───┬───┐

│ F │ F │ F │ F │

│ C │ C │ C │ C │

│ 1 │ 4 │ 5 │ 6 │

├───┴───┴───┴───┤

│ │

│ BASE │

│ │

└───────────────┘

FC1 BDAM (DAM in VSE) supportFC4 RBA access to keyed filesFC5 Concurrent file updatesFC6 Record Level Sharing (RLS)

Note: Because BDAM (or DAM in VSE) support is non-strategic, we’ve assigned all BDAM (DAM)support to its own tower (FC1). The file control base therefore applies only to VSAM or VSAM-like dataaccess.

Table 132. File control support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y Y Y D Y Y Y D

FC1 Y Y Y Y Y Y Y Y Y Y Y Y

FC4 Y Y Y Y Y Y Y Y Y Y Y Y

FC5 Y Y N N N N N N N N N N

FC6 Y N N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base D D D D D D D D D Y Y Y

FC1 N N N N N N N N N N N N





file control

Base

File control provides access to three types of data set:

In the description of the file control base that follows, the single support table is followed by three standarddefinition tables, one for each of the three data set types.

Table 133. Data set types

Data set type Description

Keyed (KSDS) Records are of variable length and are identified by a key imbedded in the record. Keys canbe from 1 to 255 bytes long and are unique. Records can be retrieved, updated, added, ordeleted.

Addressed(ESDS)

Records are of variable length and are identified by their address in the data set (4-byterelative byte address, RBA, starting from 0). Records can be retrieved and updated, but notdeleted. Records can be added only to the end of the data set.

Numbered(RRDS)

Records are of fixed length and are identified by their 4-byte relative record number (RRN),starting from 1. Records can be retrieved, updated, added, or deleted.

Table 134. File control base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y Y Y D Y Y Y D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D D D D D D Y Y Y

Note: In the standard definition tables that follow, the FILE option appears on every command, identifyingthe name of the file on which to operate. FILE is a synonym for the obsolete DATASET option. Formigration purposes, CICS/ESA, CICS/MVS, and CICS/400 systems still accept DATASET. See page 76for an explanation of the notes.

Table 135 (Page 1 of 4). File control base—keyed file standard definition


DELETE FILE�GENERICKEYLENGTH�

NUMREC�

RIDFLD�

SYSID�

DISABLEDDUPKEYFILENOTFOUNDILLOGICINVREQIOERRISCINVREQNOTAUTHNOTFNDNOTOPENSYSIDERR

68 API Structure

file control



ENDBR FILE�REQID�

SYSID�

DISABLED$

FILENOTFOUNDILLOGICINVREQISCINVREQNOTAUTHNOTOPEN$

SYSIDERR

READ EQUALFILE�GENERICGTEQINTO�

KEYLENGTH�

LENGTH��

RIDFLD�

SET�SYSID�

UPDATE

DISABLEDDUPKEYFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPENSYSIDERR

READNEXT FILE�INTO�

KEYLENGTH�

LENGTH��

REQID�

RIDFLD��

SET�SYSID�

DISABLED$

DUPKEYENDFILEFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPEN$

SYSIDERR

READPREV FILE�INTO�

KEYLENGTH�

LENGTH��

REQID�

RIDFLD��

SET�SYSID�

DISABLED$

DUPKEYENDFILEFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPEN$

SYSIDERR

File control 69

file control



RESETBR EQUALFILE�GENERICGTEQKEYLENGTH�

REQID�

RIDFLD�

SYSID�

DISABLED$

FILENOTFOUNDILLOGICINVREQIOERRISCINVREQNOTAUTHNOTFNDNOTOPEN$

SYSIDERR

REWRITE FILE�FROM�

LENGTH�

SYSID�

DISABLED$

DUPRECFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOSPACENOTAUTHNOTOPEN$

SYSIDERR

STARTBR EQUALFILE�GENERICGTEQKEYLENGTH�

REQID�

RIDFLD�

SYSID�

DISABLEDFILENOTFOUNDILLOGICINVREQIOERRISCINVREQNOTAUTHNOTFNDNOTOPENSYSIDERR

UNLOCK FILE�SYSID�

DISABLEDFILENOTFOUNDILLOGICIOERRISCINVREQNOTOPENSYSIDERR

70 API Structure

file control



WRITE FILE�FROM�

KEYLENGTH�

LENGTH�

MASSINSERTRIDFLD�

SYSID�

DISABLEDDUPRECFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOSPACENOTAUTHNOTOPENSYSIDERR

Table 136 (Page 1 of 3). File control base—addressed file standard definition


DELETE FILE�RBARIDFLDSYSID�

DISABLEDFILENOTFOUNDINVREQISCINVREQNOTAUTHNOTOPENSYSIDERR


SYSID�

DISABLED$


SYSIDERR

READ FILE�INTO�

LENGTH��

RBA�RIDFLD�

SET�SYSID�

UPDATE

DISABLEDFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTFNDNOTAUTHNOTOPENSYSIDERR

File control 71

file control




LENGTH��

RBAREQID�

RIDFLD��

SET�SYSID�

DISABLED$

ENDFILEFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPEN$

SYSIDERR


LENGTH��

RBAREQID�

RIDFLD��

SET�SYSID�

DISABLED$


SYSIDERR

RESETBR FILE�RBAREQID�

RIDFLD�

SYSID�

DISABLED$


SYSIDERR


LENGTH�

SYSID�

DISABLED$


SYSIDERR

72 API Structure

file control



STARTBR FILE�RBAREQID�

RIDFLD�

SYSID�



DISABLEDFILENOTFOUNDILLOGICIOERRISCINVREQNOTAUTHNOTOPENSYSIDERR


LENGTH�

MASSINSERTRBARIDFLD�

SYSID�

DISABLEDFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOSPACENOTAUTHNOTOPENSYSIDERR

Table 137 (Page 1 of 4). File control base—numbered file standard definition


DELETE FILE�RIDFLD�

RRNSYSID�


File control 73

file control




SYSID�

DISABLED$


SYSIDERR

READ FILE�INTO�

LENGTH��

RIDFLD�

RRNSET�SYSID�

UPDATE

DISABLEDFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPENSYSIDERR


LENGTH��

REQID�

RIDFLD��

RRNSET�SYSID�

DISABLED$


SYSIDERR


LENGTH��

REQID�

RIDFLD��

RRNSET�SYSID�

DISABLED$

ENDFILEFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOTOPEN$

SYSIDERR

74 API Structure

file control



RESETBR EQUALFILE�GTEQREQID�

RIDFLD�

RRNSYSID�

DISABLED$


SYSIDERR


LENGTH�

SYSID�

DISABLED$


SYSIDERR

STARTBR EQUALFILE�GTEQREQID�

RIDFLD�

RRNSYSID�



DISABLEDFILENOTFOUNDILLOGICIOERRISCINVREQNOTAUTHNOTOPENSYSIDERR

File control 75

file control




LENGTH�

MASSINSERTRIDFLD�

RRNSYSID�

DISABLEDDUPRECFILENOTFOUNDILLOGICINVREQIOERRISCINVREQLENGERRNOTAUTHNOSPACENOTOPENSYSIDERR

Note: The DISABLED and NOTOPEN conditions will not be raised for local execution of ENDBR,READNEXT, READPREV, RESETBR, and REWRITE commands on ESA 3.2.1 and later releasesand on CICS/400.

The differences table below applies to all three parts of the file control base.

Table 138. File control—explicit loading base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENDBR, READNEXT, READPREV, RESETBR, and STARTBR commands

REQID option 1 1 1 1

WRITE command

MASSINSERT option 1 1 1 1 2 2 2 2 2 1 1 1

DELETE, ENDBR, READ, READNEXT, READPREV, RESETBR, REWRITE, STARTBR, UNLOCK, and WRITE commands

FILE option 3 3

FILENOTFOUND condition 4 4

NOTAUTH condition 5

Notes:

1. Supported for commands executed remotely, ignored for commands executed locally.

2. Ignored for commands whether executed locally or remotely.

3. Implemented as the DATASET option; later releases allow DATASET as an undiagnosedsynonym for FILE.

4. Implemented as the DSIDERR condition; later releases allow DSIDERR as an undiagnosedsynonym for FILENOTFOUND.

5. Returned for commands executed remotely, not raised for commands executed locally.

76 API Structure

file control

BDAM (DAM) support—tower FC1

Access to BDAM (or DAM in VSE) data sets.

Table 139. BDAM (DAM) support tower (FC1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 140 (Page 1 of 2). BDAM (DAM) support tower (FC1) standard definition



SYSID�

DISABLED$

FILENOTFOUNDINVREQISCINVREQNOTAUTHSYSIDERR

READ DEBKEYDEBRECFILE�INTO�

KEYLENGTH�

LENGTH��

RIDFLD�

SET�SYSID�

UPDATE

DISABLEDFILENOTFOUNDINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDNOTOPENSYSIDERR


KEYLENGTH�

LENGTH��

REQID�

RIDFLD��

SET�SYSID�

ENDFILEFILENOTFOUNDINVREQIOERRISCINVREQLENGERRNOTAUTHNOTFNDSYSIDERR

RESETBR FILE�KEYLENGTH�

REQID�

RIDFLD�

SYSID�

DISABLED$

FILENOTFOUNDINVREQIOERRISCINVREQNOTAUTHNOTFNDNOTOPEN$

SYSIDERR

File control 77

file control

Table 140 (Page 2 of 2). BDAM (DAM) support tower (FC1) standard definition



LENGTH�

SYSID�

DISABLED$

FILENOTFOUNDINVREQIOERRISCINVREQLENGERRNOTAUTHNOSPACENOTOPEN$

SYSIDERR

STARTBR DEBKEYDEBRECFILE�KEYLENGTH�

REQID�

RIDFLD�

SYSID�

DISABLEDFILENOTFOUNDINVREQIOERR$

ISCINVREQNOTAUTHNOTFNDNOTOPENSYSIDERR


DISABLEDFILENOTFOUNDIOERRISCINVREQNOTAUTHNOTOPENSYSIDERR


KEYLENGTH�

LENGTH�

RIDFLD�

SYSID�

DISABLEDDUPRECFILENOTFOUNDINVREQIOERRISCINVREQLENGERRNOTAUTHNOSPACENOTFNDNOTOPENSYSIDERR

Note: Only VSE 2.2 and VSE 2.1 return the DISABLED condition on ENDBR, RESETBR, and REWRITE,the NOTOPEN condition on RESETBR and REWRITE, and the IOERR condition on STARTBR.

RBA access to keyed files—tower FC4

Identify records in a keyed file by relative byte address rather than record key.

78 API Structure

file control

Table 141. RBA access to keyed files tower (FC4) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 142. RBA access to keyed files tower (FC4) standard definition


DELETEREADREADNEXTREADPREVRESETBRSTARTBRWRITE

RBA

File control 79

file control

Concurrent File Updates—FC5

Concurrent file updates.

Table 143. Concurrent File Updates tower (FC5) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 144. Concurrent File Updates (FC5) standard definition


DELETEREWRITEUNLOCK

TOKEN� INVREQ

READ TOKEN� INVREQ

Record Level Sharing—FC6

Support VSAM Record Level Sharing (RLS).

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 145 (Page 1 of 2). Record Level Sharing (FC6) standard definition


READREADNEXTREADPREV

CONSISTENTREPEATABLEUNCOMMITTEDNOSUSPEND

LOCKEDRECORDBUSY

DELETEREWRITEWRITE

NOSUSPEND RECORDBUSY

DELETEREWRITEWRITE

LOCKED

80 API Structure

file control

Table 145 (Page 2 of 2). Record Level Sharing (FC6) standard definition


READNEXTREADPREV

TOKEN�

UPDATELOCKED

File control 81

file control

82 API Structure

interval control—task

Interval control—task-related

Table 146. Interval control—task-related base and towers

┌──────┐

│ I │

│ C │

│ K │

│ 5 │

├──────┤

│ │

│ BASE │

│ │

└──────┘

ICK5 FMH

Table 147. Interval control—task-related support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y D D D D D D D D D D

ICK5 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


ICK5 N N N N N N N N N N N N

Base

Request that a task be started, cancel the request before the task starts, and retrieve data for the taskonce it has started.

Table 148. Interval control—task-related base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y D D D D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2




CANCEL REQID�

SYSID�

TRANSID�

INVREQISCINVREQNOTAUTHNOTFNDSYSIDERR





RETRIEVE INTO�

LENGTH��

QUEUE�RTERMID�

RTRANSID�

SET�WAIT

ENDDATAENVDEFERRINVREQINVTSREQ1

IOERRLENGERRNOTFND

START AFTERATFROM�

HOURS�INTERVAL�LENGTH�

MINUTES�NOCHECKQUEUE�PROTECTQUEUE�REQID�

RTERMID�

RTRANSID�

SECONDS�SYSID�

TERMID�

TIME�TRANSID�

USERID�

INVREQIOERRISCINVREQLENGERRNOTAUTHSYSIDERRTERMIDERRTRANSIDERRUSERIDERR

Note: Early versions of the CICS/OS/VS and CICS/DOS/VS products returned the INVTSREQ conditionon the RETRIEVE command. The condition is retained for application portability.


TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CANCEL command


RETRIEVE command



WAIT option N N N N N


START command

AT option N N N N

AFTER option N N N N


84 API Structure



TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


NOCHECK option N

PROTECT option N




USERID option N N N N N N N N N N T N N N N N N N N N N N

LENGERR condition N N N N N N N N N

FMH—tower ICK5

Pass user data containing Function Management Headers to the started task.

Table 151. FMH tower (ICK5) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 152. FMH tower (ICK5) standard definition


START FMH

Interval control—task-related 85


86 API Structure

interval control—time

Interval control—time-related

Table 153. Interval control—time-related base and towers

┌──────┐

│ │

│ BASE │

│ │

└──────┘

Table 154. Interval control—time-related support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y D D D D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Base

Request current date and time of day.

Table 155. Interval control—time-related base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y D D D D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 156 (Page 1 of 2). Interval control—time-related base standard definition


ASKTIME ABSTIME�


interval control—time

Table 156 (Page 2 of 2). Interval control—time-related base standard definition


FORMATTIME ABSTIME�DATE�DATEFORM�

DATESEP�DAYCOUNT�DAYOFMONTH�

DAYOFWEEK�DDMMYY�DDMMYYYY�MMDDYY�MMDDYYYY�MONTHOFYEAR�

TIME�TIMESEP�YEAR�

YYDDD�

YYDDMM�

YYMMDD�

YYYYDDD�

YYYYDDMM�

YYYYMMDD�

INVREQ

Table 157. Interval control—time-related base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

FORMATTIME command

DDMMYYYY option N N N N N N N N N N N N N N N N N N N

MMDDYYYY option N N N N N N N N N N N N N N N N N N N

YYYYDDD option N N N N N N N N N N N N N N N N N N N

YYYYDDMM option N N N N N N N N N N N N N N N N N N N

YYYYMMDD option N N N N N N N N N N N N N N N N N N N

ERROR condition Y Y Y Y Y Y Y Y Y

88 API Structure

interval control—event

Interval control—event-related

Table 158. Interval control—event-related base and towers

┌──────┐

│ I │

│ C │

│ E │

│ 2 │

├──────┤

│ │

│ BASE │

│ │

└──────┘

ICE2 Support NAME on WAIT

Table 159. Interval control—event-related support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


ICE2 Y Y N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


ICE2 Y N N N N N N N N N N N

Base

Synchronize tasks.

Table 160. Interval control—event-related base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 161 (Page 1 of 2). Interval control—event-related base standard definition


CANCEL REQID�

SYSID�

TRANSID�

INVREQISCINVREQNOTFNDSYSIDERR



Table 161 (Page 2 of 2). Interval control—event-related base standard definition


DELAY FORHOURS�INTERVAL�MINUTES�REQID�

SECONDS�TIME�UNTIL

EXPIREDINVREQ

POST AFTERATHOURS�INTERVAL�MINUTES�REQID�

SECONDS�SET�TIME�

EXPIREDINVREQ

WAIT EVENT ECADDR� INVREQ

Table 162. Interval control—event-related base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CANCEL command

INVREQ condition N N N N N N N N

DELAY command

FOR option N N N N




UNTIL option N N N N

POST command

command N N N N N N N N

FOR option N N N N




UNTIL option N N N N

WAIT EVENT command

command N N N N N N N N

90 API Structure


Support NAME on WAIT—ICE2

Associate WAIT with a NAME token to assist problem determination.

Table 163. Support NAME on WAIT tower (ICE2) support.

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 164. Support NAME on WAIT (ICE2) standard definition


WAIT EVENT NAME�

Interval control—event-related 91


92 API Structure

journal control

Journal control

Table 165. Journal control base and towers

┌─────┬─────┐

│ J │ J │

│ N │ N │

│ 2 │ 3 │

├─────┴─────┤

│ │

│ BASE │

│ │

└───────────┘

JN2 Alternative journaling commandsJN3 Alternative journaling commands

Table 166. Journal control support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y N N N N N N N

JN2 Y Y Y Y Y Y Y Y Y Y Y Y

JN3 Y N N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base N N N N N N N N N Y Y Y

JN2 N N N N Y Y Y Y Y N N N

JN3 N N N N N N N N N N N N

Base

Create a journal record, and synchronize a task with the output of journal records.

Table 167. Journal control base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

N N N N N N N N N Y Y Y

Table 168 (Page 1 of 2). Journal control base standard definition


WAIT JOURNALNUM� REQID�

STARTIO1

INVREQIOERRJIDERRNOTOPEN


journal control

Table 168 (Page 2 of 2). Journal control base standard definition


WRITE JOURNALNUM� FROM�

JTYPEID�

LENGTH�

NOSUSPENDPFXLENG�

PREFIX�REQID�

STARTIOWAIT

IOERRJIDERRLENGERRNOJBUFSPNOTAUTHNOTOPEN

Note: The CICS/400 products initiate output immediately whether or not the STARTIO option is specifiedon the WAIT JOURNALNUM command.

Alternative journaling commands—tower JN2


Table 169. Alternative journaling commands tower (JN2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

N N N N Y Y Y Y Y N N N

Note: The tower is provided solely for migration purposes.

Table 170. Alternative journaling commands tower (JN2) standard definition


JOURNAL FROM�

JFILEID�

JTYPEID�

LENGTH�

NOSUSPENDPFXLENG�

PREFIX�REQID�

STARTIOWAIT

IOERRJIDERRLENGERRNOJBUFSPNOTAUTHNOTOPEN

WAIT JOURNAL JFILEID�

REQID�

STARTIO1

INVREQIOERRJIDERRNOTOPEN

Note: The CICS for AIX and CICS/6000 products initiate output immediately whether or not the STARTIOoption is specified on the WAIT JOURNAL command.

94 API Structure

journal control

Alternative journaling commands—tower JN3


Table 171. Alternative journaling commands tower (JN3) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 172. Alternative journaling commands tower (JN3) standard definition


WAIT JOURNALNAME� REQID� INVREQIOERRJIDERRNOTOPEN

WRITE JOURNALNAME� FROM�

JTYPEID�

FLENGTH�

NOSUSPENDPFXLENG�

PREFIX�REQID�

WAIT

INVREQIOERRJIDERRLENGERRNOJBUFSPNOTAUTHNOTOPEN

Journal control 95

journal control

96 API Structure

monitoring

Monitoring

Table 173. Monitoring base and towers

┌──────┐

│ M │

│ N │

│ 2 │

├──────┤

│ │

│ BASE │

│ │

└──────┘

MN2 Alternative monitoring command

Table 174. Monitoring support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y N N N Y N N N

MN2 Y Y Y Y Y Y Y Y Y Y Y Y

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base N N N N N N N N N N N N

MN2 N N N N D D D D D N N N

Base

Specify an event monitoring point using the MONITOR command.

Table 175. Monitoring base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y N N N Y N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 176. Monitoring base standard definition


MONITOR DATA1�DATA2�ENTRYNAME�POINT�

INVREQ


monitoring

Alternative monitoring command—tower MN2

Specify an event monitoring point using the ENTER TRACEID MONITOR command.

Table 177. Alternative monitoring command tower (MN2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

N N N N D D D D D N N N

Note: The tower is provided solely for migration purposes.

Table 178. Alternative monitoring command tower (MN2) standard definition


ENTER TRACEID MONITOR ACCOUNTENTRYNAME�FROM�

PERFORMRESOURCE�

INVREQ

Table 179. Alternative monitoring command tower (MN2) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENTER TRACEID MONITOR command

ACCOUNT option T T T T T

98 API Structure

program control

Program control

Table 180. Program control base and towers

┌──────┐

│ │

│ BASE │

│ │

└──────┘

Table 181. Program control support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y D D D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y D D D D D D D D Y Y D

Base

Transfer control to another application program, and return control to another application program or toCICS.

Table 182. Program control base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y D D D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y D D D D D D D D Y Y D

Table 183 (Page 1 of 2). Program control base standard definition


LINK1 COMMAREA��DATALENGTH�

INPUTMSG�

INPUTMSGLEN�

LENGTH�

PROGRAM�

SYNCONRETURNSYSID�

TRANSID�

INVREQLENGERRNOTAUTHPGMIDERRROLLEDBACKSYSIDERRTERMERR


program control

Table 183 (Page 2 of 2). Program control base standard definition


RETURN COMMAREA�IMMEDIATEINPUTMSG�

INPUTMSGLEN�

LENGTH�

TRANSID�

INVREQLENGERR

XCTL COMMAREA��INPUTMSG�

INPUTMSGLEN�

LENGTH�

PROGRAM�

LENGERRNOTAUTHPGMIDERR

Note: OS/2 1.20 does not support recursive LINK commands.

Table 184. Program control base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

LINK command

DATALENGTH option N N N N N N N N N

INPUTMSG option N N N N N N N N N N N N N N

INPUTMSGLEN option N N N N N N N N N N N N N N

SYNCONRETURN option N N N N N N N N N

SYSID option N N N N N N N

TRANSID option N N N N N N N N N

LENGERR condition N N N N N N N N

SYSIDERR condition N N N N N N N

ROLLEDBACK condition N N N N N N N N N

TERMERR condition N N N N N N N N N

RETURN command

IMMEDIATE option N N N N N N N N N N N N N N N N

INPUTMSG option N N N N N N N N N N N N N N N N

INPUTMSGLEN option N N N N N N N N N N N N N N N N


XCTL command

INPUTMSG option N N N N N N N N N N N N N N

INPUTMSGLEN option N N N N N N N N N N N N N N


100 API Structure

program control—explicit loading

Program control—explicit loading

Table 185. Program control—explicit loading base and towers

┌──────┐

│ E │

│ L │

│ 1 │

├──────┤

│ │

│ BASE │

│ │

└──────┘

EL1 Length error

Table 186. Program control—explicit loading support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


EL1 Y Y Y Y Y N N N Y N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y D D D Y Y Y Y Y D D D

EL1 N N N N N N N N N N N N

Base

Load a program into main storage.

Table 187. Program control—explicit loading base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y D D D Y Y Y Y Y D D D

Table 188. Program control—explicit loading base standard definition


LOAD ENTRY�FLENGTH�

HOLDLENGTH�

PROGRAM�

SET�

INVREQ1

NOTAUTHPGMIDERR

RELEASE PROGRAM� INVREQNOTAUTHPGMIDERR


program control—explicit loading

Note: The INVREQ condition may be returned on the LOAD command if the command is issued beforesystem initialization is complete.

Table 189. Program control—explicit loading base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

LOAD command

ENTRY option N N N


LENGTH option N N N

RELEASE command

command N N N

Length error—tower EL1

Support the LENGERR condition, indicating that the loaded program is longer than 32K bytes, and cannotbe returned using the LENGTH option.

Table 190. Length error tower (EL1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 191. Length error tower (EL1) standard definition


LOAD LENGERR

102 API Structure

storage control

Storage control

Table 192. Storage control base and towers

┌──────┬─────┐

│ │ │

│ BASE │ SC5 │

│ │ │

└──────┴─────┘

SC5 GETMAIN S/390 specific options

Table 193. Storage control support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y D D D D D D D D D

SC5 D D D D D N N N D D D N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y Y Y D D D D D D D D D

SC5 Y N N N N N N N N D D D

Base

Get and free an area of main storage.

Table 194. Storage control base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y D D D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 195. Storage control base standard definition


FREEMAIN DATA�DATAPOINTER�

INVREQ

GETMAIN FLENGTH�

INITIMG�

LENGTH�

NOSUSPENDSET�SHARED

LENGERRNOSTG


storage control

Table 196. Storage control base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

FREEMAIN command

DATAPOINTER option N N N N N N N N N N N N N N N N N N

INVREQ condition N N N N N N N N N N N N

GETMAIN S/390 specific options—tower SC5

Get an area of main storage with specified attributes.

Note: All family members should recognize the S/390 specific options for compatibility.

Table 197. GETMAIN S/390 specific options tower (SC5) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

D D D D D N N N D D D N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y N N N N N N N N D D D

Table 198. GETMAIN S/390 specific options tower (SC5) standard definition


GETMAIN ANYBELOWCICSDATAKEYUSERDATAKEY

Table 199. GETMAIN S/390 specific options tower (SC5) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

GETMAIN command

CICSDATAKEY option N N N N N N N N

USERDATAKEY option N N N N N N N N

104 API Structure

syncpoint

Syncpoint

Table 200. Syncpoint base and towers

┌───────┐

│ SP1 │

├───────┤

│ BASE │

└───────┘

SP1 “Backout required program” state

Table 201. Syncpoint support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


SP1 D D D D N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


SP1 N N N N Y Y Y Y Y N N N

Base

Synchronize the commitment of recoverable data.

Note: Although all products support the base, you will find that there are differences between the familymembers. These differences, however, are apparent in the semantics rather than in the syntax of the API.

Table 202. Syncpoint base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 203. Syncpoint base standard definition


SYNCPOINT ROLLBACK INVREQROLLEDBACK


syncpoint

“Backout required program” state—tower SP1

The “backout required program” state forces a rollback if a SYNCPOINT command is issued, preventingfurther activity on all recoverable APPC conversations for the transaction. It is set when:

� A TERMERR condition is returned on a recoverable APPC conversation

� An ISSUE ABEND command is sent on a recoverable APPC conversation.

Note: This tower defines a “state”, dependent on the behavior of other parts of the API. It does notcontain any API commands itself.

Table 204. “Backout required program” state tower (SP1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

D D D D N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

N N N N Y Y Y Y Y N N N

Table 205. “Backout required program” state tower (SP1) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

1 1 1 1

Note:

1. Do not prevent further commands being issued on recoverable APPC conversations after the“backout required program” state is set.

106 API Structure

task control

Task control

Table 206. Task control base and towers

┌───┬───┐

│ K │ K │

│ C │ C │

│ 3 │ 7 │

├───┴───┤

│ │

│ BASE │

│ │

└───────┘

KC3 Change priorityKC7 Wait on S/390 format ECBs

Table 207. Task control support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


KC3 Y Y Y Y Y N N N Y N N N

KC7 Y Y D D D N N N D N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


KC3 Y Y Y N N N N N N N N N

KC7 N N N N N N N N N N N N

Base

Schedule use of a resource by a task, and relinquish control to a task of higher or equal dispatchingpriority.

Table 208. Task control base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 209 (Page 1 of 2). Task control base standard definition


DEQ LENGTH�

LUWMAXLIFETIME�RESOURCE�TASK

INVREQLENGERR


task control

Table 209 (Page 2 of 2). Task control base standard definition


ENQ LENGTH�

LUWMAXLIFETIME�NOSUSPENDRESOURCE�TASK

ENQBUSYINVREQLENGERR

SUSPEND

Table 210. Task control base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DEQ command

LUW option N N N N N N N N N N N N N N N N

MAXLIFETIME option N N N N N N N N N N N N N N N N

TASK option N N N N N N N N N N N N N N N N


ENQ command

LUW option N N N N N N N N N N N N N N N N

MAXLIFETIME option N N N N N N N N N N N N N N N N

TASK option N N N N N N N N N N N N N N N N


SUSPEND command

command T T T

108 API Structure

task control

Change priority—tower KC3

Change the priority of a task.

Table 211. Change priority tower (KC3) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y Y Y N N N N N N N N N

Table 212. Change priority tower (KC3) standard definition


CHANGE TASK PRIORITY� INVREQ

Wait on S/390 format ECBs—tower KC7

Wait for events that post S/390 format ECBs.

Table 213. Wait on S/390 format ECBs tower (KC7) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y D D D N N N D N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 214. Wait on S/390 format ECBs tower (KC7) standard definition


WAIT EXTERNALWAITCICS

ECBLIST�NAME�NOTPURGEABLENUMEVENTS�PURGEABILITY�PURGEABLE

INVREQ

Task control 109

task control

Table 215. Wait on S/390 format ECBs tower (KC7) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

WAIT EXTERNAL command

NAME option N N N N

WAITCICS command

command N

NAME option N N N

110 API Structure

temporary storage

Temporary storage

Table 216. Temporary storage base and towers

┌───────┐

│ T │

│ S │

│ 1 │

├───────┤

│ │

│ BASE │

│ │

└───────┘

TS1 Locking for in-doubt wait

Table 217. Temporary storage support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y D D D D D D D

TS1 Y N N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base D D D D D D D D D Y Y Y

TS1 N N N N N N N N N N N N

Base

Read, write, and delete temporary storage (TS) queues.

Table 218. Temporary storage base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y D D D D D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D D D D D D Y Y Y

Table 219 (Page 1 of 2). Temporary storage base standard definition


DELETEQ TS1 QUEUE�SYSID�

INVREQISCINVREQNOTAUTHQIDERRSYSIDERR


temporary storage

Table 219 (Page 2 of 2). Temporary storage base standard definition


READQ TS INTO�

ITEM�

LENGTH��

NEXTNUMITEMS�QUEUE�SET�SYSID�

INVREQIOERRISCINVREQITEMERRLENGERRNOTAUTHQIDERRSYSIDERR

WRITEQ TS AUXILIARYFROM�

ITEM��

LENGTH�

MAINNUMITEMS�NOSUSPENDQUEUE�REWRITESYSID�

INVREQIOERRISCINVREQITEMERRLENGERRNOSPACENOTAUTHQIDERRSYSIDERR

Note: The CICS for AIX and CICS/6000 products also return the IOERR condition on the DELETEQ TScommand.

Table 220. Temporary storage base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DELETEQ TS command

INVREQ condition N N N N

WRITEQ TS command

MAIN option 1 1 1 1

NOSUSPEND T T T T

NUMITEMS option N N N N N N N N N N N N N N N N

Note:

1. Queues are written to auxiliary storage.

112 API Structure

temporary storage

Locking for in-doubt wait—TS1

Support for locking of queue when waiting on an in-doubt unit of work.

Table 221. Locking for in-doubt wait tower (TS1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 222. Locking for in-doubt wait (TS1) standard definition


DELETEQ TSWRITEQ TS

LOCKED

Temporary storage 113

temporary storage

114 API Structure

terminal control (3270)

Terminal control (3270)

Table 223. Terminal control (3270) base and towers

┌───┬───┬───┬───┬───┬───┐

│ T │ T │ T │ T │ T │ T │

│ C │ C │ C │ C │ C │ C │

│ 2 │ 4 │ 5 │ 6 │ 7 │ 8 │

│ │ │ │ │ │ │

├───┴───┴───┴───┴───┴───┤

│ │

│ BASE │

│ │

└───────────────────────┘

TC2 Extended terminal control (3270)TC4 Select ERASE screensizeTC5 HANDLE AIDTC6 S/390 application routingTC7 Terminal disconnectionTC8 Access VTAM logon data

Table 224. Terminal control (3270) support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


TC2 Y Y Y Y Y Y Y Y Y Y Y Y

TC4 Y Y N N N N N N Y N N N


TC6 Y Y Y D D D D D D D D D



OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


TC2 D D D D N N N N N D D D

TC4 Y N N N N N N N N N N N

TC5 Y D D D Y Y Y Y Y D D D

TC6 N N N N N N N N N N N N



Base

Communicate with a 3270 logical unit.

Table 225. Terminal control (3270) base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2




Table 226. Terminal control (3270) base standard definition


CONVERSE ASISCTLCHAR�

DEFRESPERASEFROM�

FROMFLENGTH�

FROMLENGTH�

INTO�

MAXFLENGTH�

MAXLENGTH�

NOTRUNCATESET�STRFIELD1

TOFLENGTH��

TOLENGTH��

INVREQLENGERRNOTALLOCTERMERR

RECEIVE ASISBUFFERFLENGTH��

INTO�

LENGTH��

MAXFLENGTH�

MAXLENGTH�

NOTRUNCATESET�


SEND CTLCHAR�

DEFRESPERASEFLENGTH�

FROM�

INVITELASTLENGTH�

STRFIELD1

WAIT


Note: Structured fields are not defined in the 3270 ASCII Data Stream Architecture.

Table 227 (Page 1 of 2). Terminal control (3270) base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONVERSE command

ASIS option N N N N N N

DEFRESP option N N N N N

FROMFLENGTH option N N N

MAXFLENGTH option N N N

116 API Structure


Table 227 (Page 2 of 2). Terminal control (3270) base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TOFLENGTH option N N N

RECEIVE command

ASIS option N


MAXFLENGTH option N N N

SEND command

DEFRESP option N N N N N


INVITE option N N N N N N N N

LAST option N N N N N N N N

LENGERR condition N

Terminal control (3270) 117


Extended terminal control (3270)—tower TC2

Support additional 3270 logical unit functions.

Table 228. Extended terminal control (3270) tower (TC2) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

D D D D N N N N N D D D

Table 229. Extended terminal control (3270) tower (TC2) standard definition


ISSUE COPY CTLCHAR�

TERMID�

WAIT

LENGERRNOTALLOCTERMERR

ISSUE ERASEAUP WAIT NOTALLOCTERMERR

ISSUE PRINT NOTALLOCTERMERR

Table 230. Extended terminal control (3270) tower (TC2) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ISSUE COPY command

command N N N N N N N

ISSUE ERASEAUP command

command N N N N

ISSUE PRINT command

command N N N

118 API Structure


Select ERASE screensize—tower TC4

Allow selection of screensize for ERASE option.

Table 231. Select ERASE screensize tower (TC4) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y N N N N N N Y N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 232. Select ERASE screensize (TC4) standard definition


CONVERSESEND

ALTERNATEDEFAULT

HANDLE AID—tower TC5

Communicate with a 3270 logical unit.

Table 233. HANDLE AID tower (TC5) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y D D D Y Y Y Y Y D D D

Table 234. HANDLE AID (TC5) standard definition


HANDLE AID ANYKEY�CLEAR�

CLRPARTN�1

ENTER�

LIGHTPEN�

OPERID�

PA1� to PA3�PF1� to PF24�TRIGGER�1

POP HANDLE2 INVREQ

PUSH HANDLE2



Notes:

1. The CLRPARTN and TRIGGER AIDs are not defined in the 3270 ASCII Data StreamArchitecture.

2. The POP HANDLE and PUSH HANDLE commands are used in the context of terminal controlto suspend and restore the current effect of HANDLE AID commands.

Table 235. HANDLE AID tower (TC5) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

HANDLE AID command

CLRPARTN option N N N

LIGHTPEN option N N N

OPERID option N N N N N N

TRIGGER option N N N

POP HANDLE command

INVREQ condition N

S/390 VTAM Application Routing—tower TC6

Disconnect the terminal from CICS and transfer to another VTAM application.

Table 236. S/390 VTAM Application Routing tower (TC6) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 237. S/390 VTAM Application Routing (TC6) standard definition


ISSUE PASS FROM�

LENGTH�

LOGMODE�LOGONLOGMODELUNAME�NOQUIESCE

INVREQLENGERR

120 API Structure


Table 238. S/390 VTAM Application Routing tower (TC6) differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ISSUE PASS command

LOGMODE option N N N N N N N N N

LOGONLOGMODE option N N N N N N N N N

Terminal disconnection—tower TC7

Disconnect the terminal from CICS.

Table 239. Terminal disconnection tower (TC7) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 240. Terminal disconnection tower (TC2) standard definition


ISSUE DISCONNECT NOTALLOC

Access VTAM logon data—tower TC8

Access VTAM logon data

Table 241. Access VTAM logon data tower (TC8) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 242. Access VTAM logon data (TC8) standard definition


EXTRACT LOGONMSG INTO�

LENGTH�

SET�

NOTALLOC



122 API Structure

transient data

Transient data

Table 243. Transient data base and towers

┌───────┐

│ T │

│ D │

│ 1 │

├───────┤

│ │

│ BASE │

│ │

└───────┘

TD1 Locking for in-doubt wait

| Table 244. Transient Data support

TS 1.1OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Base Y Y Y Y Y D D D Y D D D

| TD1 Y N N N N N N N N N N N

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Base Y Y Y D D D D D D Y Y Y

| TD1 N N N N N N N N N N N N

Base

Transient data (TD) queues are sequential files outside the file control functional area. They are used forrelaying data between transactions (intrapartition queues) and between transactions and the hostenvironment (extrapartition queues).

Table 245. Transient data base support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7

Y Y Y Y Y D D D Y D D D

OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2

Y Y Y D D D D D D Y Y Y

Table 246 (Page 1 of 2). Transient data base standard definition


DELETEQ TD QUEUE�SYSID�

DISABLEDINVREQISCINVREQNOTAUTHQIDERRSYSIDERR


transient data

Table 246 (Page 2 of 2). Transient data base standard definition


READQ TD INTO�

LENGTH��

NOSUSPENDQUEUE�SET�SYSID�

DISABLEDINVREQIOERRISCINVREQLENGERRNOTAUTHNOTOPENQBUSYQIDERRQZEROSYSIDERR

WRITEQ TD FROM�

LENGTH�

QUEUE�SYSID�

DISABLEDINVREQIOERRISCINVREQLENGERRNOSPACENOTAUTHNOTOPENQIDERRSYSIDERR

Table 247. Transient Data base differences

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DELETEQ TD command

DISABLED condition N N N N N N N N

INVREQ condition N N N N N N N N N N N

READQ TD command


INVREQ condition N N N N N N N N N N N

WRITEQ TD command


INVREQ condition N N N N N N N N N N N N

124 API Structure

transient data

Locking for in-doubt wait—TD1

Support for locking of queue when waiting on an in-doubt unit of work.

Table 248. Locking for in-doubt wait tower (TD1) support

TS1.1

OS/390

ESA4.1

ESA3.3

ESA3.2.1

ESA3.1.1

MVS2.1.2

MVS2.1.1

OS/VS1.7

VSE2.3

VSE2.2

VSE2.1

DOS/VS1.7


OS/2V3

OS/22.0.1

OS/2V2

OS/21.20

AIX2.1.1

AIX2.1

60001.2

60001.1.1

60001.1.0

4003.1

4002.3

4002.2


Table 249. Locking for in-doubt wait (TD1) standard definition


DELETEQ TDREADQ TDWRITEQ TD

LOCKED

Transient data 125

transient data

126 API Structure

Systems programming


128 API Structure

au

toin

stall A

UT

OIN

ST

AL

L

INQ

UIR

EA

UT

INS

TM

OD

EL

Table 250. IN

QU

IRE

AU

TIN

ST

MO

DE

Loption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

AU

TIN

ST

MO

DE

LY

YY

YN

NN

NN

NN

NN

NN

NN

NN

NN

YY

Y

INQ

UIR

EA

UT

OIN

ST

AL

L

Table 251. IN

QU

IRE

AU

TO

INS

TA

LLoption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

CU

RR

EQ

SY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

EN

AB

LES

TA

TU

SY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

MA

XR

EQ

SY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

PR

OG

RA

MY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

Table 252. IN

QU

IRE

AU

TO

INS

TA

LLC

VD

Asupport

acrossC

ICS

platforms

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

EN

AB

LES

TA

TU

S option

DIS

AB

LED

YY

YY

YN

NN

YN

NN

NN

NN

NN

NN

NN

NN

EN

AB

LED

YY

YY

YN

NN

YN

NN

NN

NN

NN

NN

NN

NN

C

opyright IBM

Corp. 1992, 1997

129

au

toin

stall

SE

TA

UT

OIN

ST

AL

L

Table 253. S

ET

AU

TO

INS

TA

LLoption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

MA

XR

EQ

SY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

PR

OG

RA

MY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

130A

PI S

tructure

co

mm

un

ication

s - access C

om

mu

nicatio

ns - access m

etho

d

INQ

UIR

EIR

C

Table 254. IN

QU

IRE

IRC

optionsupport

acrossC

ICS

platforms

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

OP

EN

ST

AT

US

YY

YY

YN

NN

YN

NN

NN

NN

NN

NN

NN

NN

Table 255. IN

QU

IRE

IRC

CV

DA

supportacross

CIC

Splatform

s

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

OP

EN

ST

AT

US

option

CLO

SE

DY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

CLO

SIN

GY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

IMM

CLO

SIN

GY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

OP

EN

YY

YY

YN

NN

YN

NN

NN

NN

NN

NN

NN

NN

SE

TIR

C

Table 256. S

ET

IRC

optionsupport

acrossC

ICS

platforms

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

OP

EN

ST

AT

US

YY

YY

YN

NN

YN

NN

NN

NN

NN

NN

NN

NN

Table 257 (P

age 1 of 2). SE

TIR

CC

VD

Asupport

acrossC

ICS

platforms

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

OP

EN

ST

AT

US

option

CLO

SE

DY

YY

YY

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

C

opyright IBM

Corp. 1992, 1997

131

communications - access

Table 257 (Page 2 of 2). SET IRC CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

IMMCLOSE Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

OPEN Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

INQUIRE VTAM

Table 258. INQUIRE VTAM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

GRNAME Y Y N N N N N N N N N N N N N N N N N N N N N N

GRSTATUS Y Y N N N N N N N N N N N N N N N N N N N N N N

OPENSTATUS Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

PSDINTERVAL Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTMINS Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTSECS Y Y N N N N N N N N N N N N N N N N N N N N N N

Table 259. INQUIRE VTAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

GRSTATUS option

DEREGERROR Y Y N N N N N N N N N N N N N N N N N N N N N N

DEREGISTERED Y Y N N N N N N N N N N N N N N N N N N N N N N

REGERROR Y Y N N N N N N N N N N N N N N N N N N N N N N

REGISTERED Y Y N N N N N N N N N N N N N N N N N N N N N N

UNAVAILABLE Y Y N N N N N N N N N N N N N N N N N N N N N N

UNREGISTERED Y Y N N N N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y Y N N N N N N N N N N N N N N N N N N N N N N

OPENSTATUS option

CLOSED Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

CLOSEFAILED Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

CLOSING Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

FORCECLOSING Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

IMMCLOSING Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N


132 API Structure


SET VTAM

Table 260. SET VTAM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


PSDINTERVAL Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTMINS Y Y N N N N N N N N N N N N N N N N N N N N N N

PSDINTSECS Y Y N N N N N N N N N N N N N N N N N N N N N N

Table 261. SET VTAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

OPENSTATUS option


FORCECLOSE Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

IMMCLOSE Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N


Communications - access method 133


134 API Structure

communications - connections

Communications - connections

INQUIRE CONNECTION

Table 262. INQUIRE CONNECTION option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONNECTION Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

ACCESSMETHOD Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

ACQSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

AUTOCONNECT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

CONNSTATUS Y Y Y Y N Y N N Y N N N Y N N N N N N N N Y Y Y

CONNTYPE Y Y N N N N N N N N N N Y N N N N N N N N N N N

EXITTRACING Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

GRNAME Y N N N N N N N N N N N N N N N N N N N N N N N

LINKSYSTEM Y N N N N N N N N N N N N N N N N N N N N N N N

MEMBERNAME Y N N N N N N N N N N N N N N N N N N N N N N N


PENDSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PROTOCOL Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

RECEIVECOUNT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

RECOVSTATUS Y N N N N N N N N N N N N N N N N N N N N N N N

REMOTENAME Y N N N N N N N N N N N N N N N N N N N N N N N

REMOTESYSNET Y N N N N N N N N N N N N N N N N N N N N N N N

REMOTESYSTEM Y N N N N N N N N N N N N N N N N N N N N N N N

SENDCOUNT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SERVSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

XLNSTATUS Y Y Y Y Y Y Y N Y N N N Y N N N N N N N N N N N

ZCPTRACING Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

Table 263 (Page 1 of 3). INQUIRE CONNECTION CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACCESSMETHOD option

INDIRECT Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N Y Y Y

IRC Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

NETBIOS N N N N N N N N N N N N Y N N N N N N N N N N N

SNA N N N N N N N N N N N N 1 N N N N N N N N N N N

TCPIP N N N N N N N N N N N N Y N N N N N N N N N N N

VTAM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y




CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

XCF Y Y N N N N N N N N N N N N N N N N N N N N N N

XM Y Y Y Y Y Y Y Y N N N Y Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

ACQSTATUS option

ACQUIRED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

RELEASED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

NOTAPPLIC Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

AUTOCONNECT option

ALLCONN Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

AUTOCONN Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

NONAUTOCONN Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

CONNSTATUS option

ACQUIRED Y Y Y Y N Y N N Y N N N Y N N N N N N N N Y Y Y

AVAILABLE Y Y Y Y N Y N N N N N N N N N N N N N N N N N N

FREEING Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N

OBTAINING Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N

RELEASED Y Y Y Y N Y N N Y N N N Y N N N N N N N N Y Y Y

NOTAPPLIC Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N

CONNTYPE option

GENERIC Y Y N N N N N N N N N N N N N N N N N N N N N N

SPECIFIC Y Y N N N N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y Y N N N N N N N N N N Y N N N N N N N N N N N

EXITTRACING option

EXITTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOEXITTRACE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

PENDSTATUS option

NOTPENDING Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PENDING Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

PROTOCOL option

APPC Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

EXCI Y Y N N N N N N N N N N N N N N N N N N N N N N

LU61 Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N


RECOVSTATUS option

NORECOVDATA Y N N N N N N N N N N N N N N N N N N N N N N N

NRS Y N N N N N N N N N N N N N N N N N N N N N N N

RECOVDATA Y N N N N N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y N N N N N N N N N N N N N N N N N N N N N N N

SERVSTATUS option

GOINGOUT Y Y Y Y Y N N N N N N N Y Y Y N N N N N N N N N

INSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OUTSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

XLNSTATUS option

136 API Structure



CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

XNOTDONE Y Y Y Y Y Y Y N Y N N N N N N N N N N N N N N N

XOK Y Y Y Y Y Y Y N Y N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y Y Y N Y N N N Y N N N N N N N N N N N

ZCPTRACING option

NOZCPTRACE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

ZCPTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

Note:

1. The SNA CVDA has the same numeric value as the VTAM CVDA.

SET CONNECTION

Table 264. SET CONNECTION option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONNECTION Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

ACQSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

AFFINITY Y N N N N N N N N N N N N N N N N N N N N N N N

CONNSTATUS Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N


FORCE PURGE 1 1 1 1 1 Y Y Y 1 Y Y Y Y Y Y Y N N N N N N N N

PENDSTATUS Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

PURGETYPE Y Y Y Y Y N N N Y N N N Y Y Y N N N N N N Y Y Y

RECOVSTATUS Y N N N N N N N N N N N N N N N N N N N N N N N

SERVSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y

UOWACTION Y N N N N N N N N N N N N N N N N N N N N N N N


Note: FORCEPURGE, used either as an option or as a CVDA, is preferred.

Communications - connections 137


Table 265. SET CONNECTION CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACQSTATUS option

ACQUIRED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

RELEASED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N

AFFINITY option

ENDAFFINITY Y N N N N N N N N N N N N N N N N N N N N N N N

CONNSTATUS option

ACQUIRED Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N

RELEASED Y Y Y Y N Y N N Y N N N Y N N N N N N N N N N N

EXITTRACING option

EXITTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

NOEXITTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

PENDSTATUS option

NOTPENDING Y Y Y Y Y 2 2 2 Y 2 2 2 T N N N N N N N N N N N

PURGETYPE option

CANCEL Y Y N N N N N N N N N N N N N N N N N N N N N N

FORCECANCEL Y Y N N N N N N N N N N N N N N N N N N N N N N

FORCEPURGE Y Y Y Y Y N N N Y N N N Y Y Y N N N N N N N N N

PURGE Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y 2 N N N N N Y Y Y

RECOVSTATUS option

NORECOVDATA Y N N N N N N N N N N N N N N N N N N N N N N N

SERVSTATUS option

INSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y

OUTSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y

UOWACTION option

BACKOUT Y N N N N N N N N N N N N N N N N N N N N N N N

COMMIT Y N N N N N N N N N N N N N N N N N N N N N N N

FORCEUOW Y N N N N N N N N N N N N N N N N N N N N N N N

RESYNC Y N N N N N N N N N N N N N N N N N N N N N N N

ZCPTRACING option

NOZCPTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

ZCPTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

Notes:

1. Specifiable only as a CVDA.2. Specifiable only as an option.

138 API Structure


INQUIRE MODENAME

Table 266. INQUIRE MODENAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

MODENAME Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

ACTIVE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

AUTOCONNECT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

AVAILABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

CONNECTION Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

MAXIMUM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

MAXWINNERS Y Y Y Y Y N N N Y N N N 1 N N N N N N N N N N N

Note:

1. The value gives the minimum number of sessions that the definition of the session group toCM/2 permits to be contention winners.

Table 267. INQUIRE MODENAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AUTOCONNECT option

ALLCONN Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

AUTOCONN Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

NONAUTOCONN Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

Communications - connections 139


SET MODENAME

Table 268. SET MODENAME option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

MODENAME Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

ACQSTATUS Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

AVAILABLE Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

CONNECTION Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

Table 269. SET MODENAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACQSTATUS option

ACQUIRED Y Y Y Y Y 2 2 2 Y 2 2 2 N N N N N N N N N N N N


Notes:


140 API Structure

communications - terminals

Communications - terminals

SET NETNAME

Table 270. SET NETNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

NETNAME Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EXITTRACING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 271. SET NETNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

EXITTRACING option


NOEXITTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

INQUIRE TERMINAL

Table 272 (Page 1 of 3). INQUIRE TERMINAL option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TERMINAL Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y


ACCESSMETHOD Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N


ALTPAGEHT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ALTPAGEWD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ALTPRINTER Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ALTPRTCOPYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ALTSCRNHT Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

ALTSCRNWD Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

ALTSUFFIX Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

APLKYBDST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

APLTEXTST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N




Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ASCII Y Y N N N N N N Y N N N Y N N N N N N N N N N N

ATISTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

AUDALARMST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

AUTOCONNECT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

BACKTRANSST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

COLORST Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

COPYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

CORRELID Y N N N N N N N N N N N N N N N N N N N N N N N

CREATESESS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DATASTREAM Y Y N N N N N N Y N N N Y N N N N N N N N N N N

DEFPAGEHT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

DEFPAGEWD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

DEFSCRNHT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

DEFSCRNWD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

DEVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y

DEVICEST N Y N N N N N N Y N N N Y N N N N N N N N N N N

DISCREQST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

DUALCASEST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N


EXTENDEDDSST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

FMHPARMST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

FORMFEEDST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

GCHARS Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y

GCODES Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y

HFORMST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

HILIGHTST Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

KATAKANAST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

LIGHTPENST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

LINKSYSTEM Y N N N N N N N N N N N N N N N N N N N N N N N

MAPNAME Y Y N N N N N N N N N N Y N N N N N N N N N N N

MAPSETNAME Y Y N N N N N N N N N N Y N N N N N N N N N N N

MODENAME Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

MSRCONTROLST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NATLANG Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

NATURE Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

NEXTTRANSID Y Y Y Y Y N N N Y Y N N Y Y N N N N N N N Y Y Y

OBFORMATST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OBOPERIDST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OPERID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

OUTLINEST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PAGEHT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PAGESTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PAGEWD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PARTITIONST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRINTADAPTST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

142 API Structure



Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PRINTER Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

PROGSYMBOLST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRTCOPYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

QUERYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

RELREQST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

REMOTENAME Y Y Y Y Y N N N Y Y N N Y N N N N N N N N Y Y Y

REMOTESYSNET Y N N N N N N N N N N N N N N N N N N N N N N N

REMOTESYSTEM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

SCREENHEIGHT 1 1 1 Y Y Y Y Y 1 1 Y Y Y Y N N Y Y Y Y Y Y Y Y

SCREENWIDTH 2 2 2 Y Y Y Y Y 2 2 Y Y Y Y N N Y Y Y Y Y Y Y Y

SCRNHT Y Y Y 3 3 3 3 3 Y Y 3 3 Y Y N N N N N N N N N N

SCRNWD Y Y Y 4 4 4 4 4 Y Y 4 4 Y Y N N N N N N N N N N

SECURITY Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

SERVSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

SESSIONTYPE Y Y Y Y N N N N Y Y N N Y N N N N N N N N Y Y Y

SIGNONSTATUS Y Y Y Y Y N N N Y Y N N Y N N N N N N N N Y Y Y

SOSIST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

SPOOLDEST N N N N N N N N Y Y Y Y Y N N N N N N N N N N N

SPOOLTO N N N N N N N N Y Y Y Y Y N N N N N N N N N N N

TASKID Y Y Y Y Y N N N Y Y N N Y N N N N N N N N Y Y Y

TCAMCONTROL Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

TERMMODEL Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y

TERMPRIORITY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

TERMSTATUS Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

TEXTKYBDST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TEXTPRINTST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TRACING Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

TRANSACTION Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

TTISTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UCTRANST Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

USERAREA Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

USERAREALEN Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N Y Y Y Y Y Y Y Y

USERID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

USERNAME Y Y Y Y N N N N N N N N Y N N N N N N N N Y Y Y

VALIDATIONST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

VFORMST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N


Notes:

1. Allowed as an undiagnosed synonym for SCRNHT.2. Allowed as an undiagnosed synonym for SCRNWD.3. Implemented as the SCREENHEIGHT option; later releases allow SCREENHEIGHT as an

undiagnosed synonym for SCRNHT.4. Implemented as the SCREENWIDTH option; later releases allow SCREENWIDTH as an

undiagnosed synonym for SCRNWD.

Communications - terminals 143


Table 273 (Page 1 of 4). INQUIRE TERMINAL CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACCESSMETHOD option

BGAM Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

BSAM Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

BTAM Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

CONSOLE Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

TCAM Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

TCAMSNA Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

VTAM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N


ACQSTATUS option


ACQUIRING Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N



ALTPRTCOPYST option

ALTPRTCOPY Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOALTPRTCOPY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

APLKYBDST option

APLKYBD Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOAPLKYBD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

APLTEXTST option

APLTEXT Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOAPLTEXT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ASCII option

ASCII7 Y Y N N N N N N Y N N N N N N N N N N N N N N N

ASCII8 Y Y N N N N N N Y N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y N N N N N N Y N N N N N N N N N N N N N N N

ATISTATUS option

ATI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

NOATI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

AUDALARMST option

AUDALARM Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NOAUDALARM Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

AUTOCONNECT option

ALLCONN Y Y N N N N N N Y N N N N N N N N N N N N N N N

AUTOCONN Y Y N N N N N N Y N N N Y N N N N N N N N N N N

NONAUTOCONN Y Y N N N N N N Y N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y N N N N N N Y N N N Y N N N N N N N N N N N

BACKTRANSST option

BACKTRANS Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOBACKTRANS Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

COLORST option

COLOR Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

NOCOLOR Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

COPYST option

144 API Structure



CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

COPY Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOCOPY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

CREATESESS option

CREATE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

NOCREATE Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N


DATASTREAM option

DS3270 Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SCS Y Y N N N N N N Y N N N N N N N N N N N N N N N


DEVICEST option

BUSY N Y N N N N N N Y N N N N N N N N N N N N N N N

NOTBUSY N Y N N N N N N Y N N N Y N N N N N N N N N N N

DISCREQST option

DISCREQ Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NODISCREQ Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

DUALCASEST option

DUALCASE Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NODUALCASE Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

EXITTRACING option




EXTENDEDDSST option

EXTENDEDDS Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NOEXTENDEDDS Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

FMHPARMST option

FMHPARM Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOFMHPARM Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

FORMFEEDST option

FORMFEED Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOFORMFEED Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

HFORMST option

HFORM Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOHFORM Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

HILIGHTST option

HILIGHT Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

NOHILIGHT Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

KATAKANAST option

KATAKANA Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NOKATAKANA Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

LIGHTPENST option

LIGHTPEN Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOLIGHTPEN Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

MSRCONTROLST option




CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

MSRCONTROL Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOMSRCONTROL Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NATURE option

MODEL Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

REMSESSION Y N N N N N N N N N N N N N N N N N N N N N N N

SESSION Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

SURROGATE Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

TERMINAL Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

OBFORMATST option

NOOBFORMAT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OBFORMAT Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

OBOPERDIST option

NOOBOPERID Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OBOPERID Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

OUTLINEST option

NOOUTLINE Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OUTLINE Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

PAGESTATUS option

AUTOPAGEABLE Y Y Y Y Y 1 1 1 Y Y 1 1 N N N N N N N N N N N N

PAGEABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PAGESTATUS 2 2 2 2 2 Y Y Y 2 2 Y Y N N N N N N N N N N N N

PARTITIONST option

NOPARTITIONS Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PARTITIONS Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

PRINTADAPTST option

NOPRINTADAPT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRINTADAPT Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

PROGSYMBOLST option

NOPROGSYMBOL Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PROGSYMBOL Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

PRTCOPYST option

NOPRTCOPY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRTCOPY Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

QUERYST option

ALLQUERY Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

COLDQUERY Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

NOQUERY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

RELREQST option

NORELREQ Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

RELREQ Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

SECURITY option

NOPRESETSEC Y Y Y Y Y N N N Y Y N N Y N N N N N N N N N N N

PRESETSEC Y Y Y Y Y N N N Y Y N N N N N N N N N N N N N N

SERVSTATUS option

GOINGOUT Y Y Y Y Y N N N Y Y N N Y Y Y Y N N N N N N N N

146 API Structure



CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

INSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OUTSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

SESSIONTYPE option

APPCPARALLEL Y Y Y Y N N N N Y Y N N Y N N N N N N N N Y Y Y

APPCSINGLE Y Y Y Y N N N N Y Y N N Y N N N N N N N N N N N

LU61 Y Y Y Y N N N N Y Y N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y N N N N Y Y N N Y N N N N N N N N Y Y Y

SIGNONSTATUS option

SIGNEDOFF Y Y Y Y Y N N N Y Y N N Y N N N N N N N N Y Y Y

SIGNEDON Y Y Y Y Y N N N Y Y N N Y N N N N N N N N Y Y Y

SOSIST option

NOSOSI Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

SOSI Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TERMSTATUS option

ACQUIRED Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

ACQUIRING Y Y Y N N N N N Y N N N N N N N N N N N N N N N

RELEASED Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

RELEASING Y Y Y N N N N N Y N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

TEXTKYBDST option

NOTEXTKYBD Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TEXTKYBD Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

TEXTPRINTST option

NOTEXTPRINT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TEXTPRINT Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

TRACING option

SPECTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STANTRACE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

TTISTATUS option

NOTTI Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

TTI Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UCTRANST option

NOUCTRAN Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

TRANIDONLY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

UCTRAN Y Y Y N N N N N Y Y N N Y Y N N N N N N N N N N

VALIDATIONST option

NOVALIDATION Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

VALIDATION Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

VFORMST option

NOVFORM Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

VFORM Y Y Y N N N N N Y Y N N N N N N N N N N N N N N

ZCPTRACING option


ZCPTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N




Notes:

1. Implemented in error as the PAGESTATUS CVDA.2. Replaced by the AUTOPAGEABLE CVDA

The AUTOPAGEABLE CVDA has the same numeric value as the PAGESTATUS CVDA.

SET TERMINAL

Table 274. SET TERMINAL option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TERMINAL Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y


ALTPRINTER Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ALTPRTCOPYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ATISTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

CANCELAID N N N Y N N N N N N N N N N N N N N N N N N N N

CREATESESS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DISCREQST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N


FORCE PURGE 1 1 1 1 1 Y Y Y 1 Y Y Y Y N N N N N N N N N N N

MAPNAME Y Y N N N N N N N N N N Y N N N N N N N N N N N

MAPSETNAME Y Y N N N N N N N N N N Y N N N N N N N N N N N

NEXTTRANSID Y Y Y Y N N N N Y Y N N Y N N N N N N N N Y Y Y

OBFORMATST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PAGESTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PRINTER Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRTCOPYST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PURGEBMS N N N Y N N N N N N N N N N N N N N N N N N N N

PURGETYPE Y Y Y Y Y N N N Y Y N N Y Y Y Y N N N N N Y Y Y

RELREQST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

SERVSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

TCAMCONTROL Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

TERMPRIORITY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

TERMSTATUS Y Y Y N N N N N Y N N N Y N N N N N N N N N N N


TTISTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UCTRANST Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N


Note:

1. FORCEPURGE, used either as an option or as a CVDA, is preferred.

148 API Structure


Table 275 (Page 1 of 2). SET TERMINAL CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACQSTATUS option


COLDACQ Y Y Y Y Y Y Y Y Y Y Y Y 3 N N N N N N N N N N N


ALTPRTCOPYST option

ALTPRTCOPY Y Y Y N N N N N Y Y N N T N N N N N N N N N N N

NOALTPRTCOPY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ATISTATUS option

ATI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

NOATI Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

CREATESESS option

CREATE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

NOCREATE Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

DISCREQST option

DISCREQ Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

NODISCREQ Y Y Y N N N N N Y Y N N T N N N N N N N N N N N

EXITTRACING option

EXITTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N


OBFORMATST option

NOOBFORMAT Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

OBFORMAT Y Y Y N N N N N Y Y N N T N N N N N N N N N N N

PAGESTATUS option

AUTOPAGEABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y N N N

PAGEABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

PRTCOPYST option

NOPRTCOPY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

PRTCOPY Y Y Y N N N N N Y Y N N T N N N N N N N N N N N

PURGETYPE option

CANCEL Y Y N N N N N N N N N N Y N N N N N N N N N N N

FORCEPURGE Y Y Y Y Y 2 2 2 Y Y 2 2 Y Y Y Y N N N N N N N N

PURGE Y Y Y Y Y 2 2 2 Y Y 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

RELREQST option

NORELREQ Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

RELREQ Y Y Y N N N N N Y Y N N T N N N N N N N N N N N

SERVSTATUS option

INSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

OUTSERVICE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N Y Y Y

TERMSTATUS option

ACQUIRED Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

COLDACQ Y Y Y N N N N N Y N N N 3 N N N N N N N N N N N

RELEASED Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

TRACING option

SPECTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N




Table 275 (Page 2 of 2). SET TERMINAL CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TTISTATUS option

NOTTI Y Y Y Y Y Y Y Y Y Y Y Y Y N N N 1 1 1 1 1 Y Y Y

TTI Y Y Y Y Y Y Y Y Y Y Y Y Y N N N 1 1 1 1 1 Y Y Y

UCTRANST option

NOUCTRAN Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

TRANIDONLY Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

UCTRAN Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

ZCPTRACING option


ZCPTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

Notes:

1. Specifiable only as a CVDA.2. Specifiable only as an option.3. COLDACQ processed as ACQUIRED

150 API Structure

communications - related

Communications - related

INQUIRE PARTNER

Table 276. INQUIRE PARTNER option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PARTNER Y Y N N N N N N N N N N N N N N N N N N N N N N

NETNAME Y Y Y Y N N N N N N N N N N N N N N N N N N N N

NETWORK Y Y Y Y N N N N N N N N N N N N N N N N N N N N

PROFILE Y Y Y Y N N N N N N N N N N N N N N N N N N N N

TPNAME Y Y Y Y N N N N N N N N N N N N N N N N N N N N

TPNAMELEN Y Y Y Y N N N N N N N N N N N N N N N N N N N N

INQUIRE PROFILE

Table 277. INQUIRE PROFILE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PROFILE Y Y Y Y N N N N N N N N N N N N N N N N N N N N

SET DELETSHIPPED

Table 278. SET DELETSHIPPED option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

IDLE Y Y N N N N N N N N N N N N N N N N N N N N N N

IDLEHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

IDLEMINS Y Y N N N N N N N N N N N N N N N N N N N N N N

IDLESECS Y Y N N N N N N N N N N N N N N N N N N N N N N

INTERVAL Y Y N N N N N N N N N N N N N N N N N N N N N N

INTERVALHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

INTERVALMINS Y Y N N N N N N N N N N N N N N N N N N N N N N

INTERVALSECS Y Y N N N N N N N N N N N N N N N N N N N N N N


communications - related

152 API Structure

data sets

Data sets

INQUIRE DSNAME

Table 279. INQUIRE DSNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DSNAME Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

ACCESSMETHOD Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

BACKUPTYPE Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

BASEDSNAME Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

BKOUTSTATUS 1 Y Y Y Y N N N N N N N Y N N N N N N N N N N N

FILECOUNT Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

FWDRECOVLOG Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

FWDRECOVLSN Y N N N N N N N N N N N N N N N N N N N N N N N

LOSTLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

OBJECT Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

QUIESCESTATE Y N N N N N N N N N N N N N N N N N N N N N N N

RECOVSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

RETLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

VALIDITY Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

Table 280 (Page 1 of 2). INQUIRE DSNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACCESSMETHOD option

BDAM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

VSAM Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BACKUPTYPE option

DYNAMIC Y Y Y Y N N N N N N N N N N N N N N N N N N N N

STATIC Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

UNDETERMINED Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

BKOUTSTATUS option

FAILEDBKOUT N Y Y Y Y N N N N N N N N N N N N N N N N N N N

FAILINGBKOUT N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NORMALBKOUT Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N


LOSTLOCKS option


data sets

Table 280 (Page 2 of 2). INQUIRE DSNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


NOLOSTLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

REMLOSTLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

RECOVERLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

OBJECT option

BASE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

PATH Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N


QUIESCESTATE option


QUIESCED Y N N N N N N N N N N N N N N N N N N N N N N N

QUIESCING Y N N N N N N N N N N N N N N N N N N N N N N N

UNQUIESCED Y N N N N N N N N N N N N N N N N N N N N N N N

RECOVSTATUS option

FWDRECOVABLE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTRECOVABLE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

RECOVERABLE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

UNDETERMINED Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


RETLOCKS option


NORETAINED Y N N N N N N N N N N N N N N N N N N N N N N N

RETAINED Y N N N N N N N N N N N N N N N N N N N N N N N

VALIDITY option

INVALID Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

VALID Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

Note:

1. Supported only for compatibility with previous releases.

154 API Structure

data sets

SET DSNAME

Table 281. SET DSNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DSNAME Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ACTION Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

AVAILABILITY Y N N N N N N N N N N N N N N N N N N N N N N N

BKOUTSTATUS 1 Y Y Y Y N N N N N N N N N N N N N N N N N N N

BUSY Y N N N N N N N N N N N N N N N N N N N N N N N

QUIESCESTATE Y N N N N N N N N N N N N N N N N N N N N N N N

UOWACTION Y N N N N N N N N N N N N N N N N N N N N N N N

Table 282. SET DSNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACTION option

RECOVERED Y Y Y Y N N N N N N N N N N N N N N N N N N N N

REMOVE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

RESETLOCKS Y N N N N N N N N N N N N N N N N N N N N N N N

RETRY Y N N N N N N N N N N N N N N N N N N N N N N N

AVAILABILITY option

AVAILABLE Y N N N N N N N N N N N N N N N N N N N N N N N

UNAVAILABLE Y N N N N N N N N N N N N N N N N N N N N N N N

BKOUTSTATUS option

FAILEDBKOUT N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NORMALBKOUT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BUSY option

NOWAIT Y N N N N N N N N N N N N N N N N N N N N N N N

WAIT Y N N N N N N N N N N N N N N N N N N N N N N N

QUIESCESTATE option

IMMQUIESCED Y N N N N N N N N N N N N N N N N N N N N N N N

QUIESCED Y N N N N N N N N N N N N N N N N N N N N N N N

UNQUIESCED Y N N N N N N N N N N N N N N N N N N N N N N N

UOWACTION option



FORCE Y N N N N N N N N N N N N N N N N N N N N N N N

Note:

1. Supported only for compatibility with prevoius releases.

Data sets 155

data sets

156 API Structure

diagnostic - dump

Diagnostic services - dump

INQUIRE DUMPDS

Table 283. INQUIRE DUMPDS option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CURRENTDDS Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

INITIALDDS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


SWITCHSTATUS Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

Table 284. INQUIRE DUMPDS CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

OPENSTATUS option



SWITCHSTATUS option

NOSWITCH Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

SWITCHNEXT Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

SET DUMPDS

Table 285. SET DUMPDS option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

INITIALDDS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


SWITCHSTATUS Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N


diagnostic - dump

Table 286. SET DUMPDS CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

OPENSTATUS option



SWITCH Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

SWITCHSTATUS option

NOSWITCH Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

SWITCHNEXT Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

INQUIRE SYSDUMPCODE

Table 287. INQUIRE SYSDUMPCODE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SYSDUMPCODE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

CURRENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DAEOPTION Y Y N N N N N N N N N N N N N N N N N N N N N N

DUMPSCOPE Y Y N N N N N N N N N N N N N N N N N N N N N N

MAXIMUM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SHUTOPTION Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSDUMPING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 288 (Page 1 of 2). INQUIRE SYSDUMPCODE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DAEOPTION option

DAE Y Y N N N N N N N N N N N N N N N N N N N N N N

NODAE Y Y N N N N N N N N N N N N N N N N N N N N N N

DUMPSCOPE option

LOCAL Y Y N N N N N N N N N N N N N N N N N N N N N N

RELATED Y Y N N N N N N N N N N N N N N N N N N N N N N

SHUTOPTION option

NOSHUTDOWN Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SHUTDOWN Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSDUMPING option

158 API Structure

d

iagn

ostic - d

um

p

Table 288 (P

age 2 of 2). INQ

UIR

ES

YS

DU

MP

CO

DE

CV

DA

supportacross

CIC

Splatform

s

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

NO

SY

SD

UM

PY

YY

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

SY

SD

UM

PY

YY

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

Diagnostic services - dum

p159

diagnostic - dump

SET SYSDUMPCODE

Table 289. SET SYSDUMPCODE option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SYSDUMPCODE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


DAEOPTION Y Y N N N N N N N N N N N N N N N N N N N N N N

DUMPSCOPE Y Y N N N N N N N N N N N N N N N N N N N N N N




Table 290. SET SYSDUMPCODE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACTION option

ADD Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


RESET Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DAEOPTION option

DAE Y Y N N N N N N N N N N N N N N N N N N N N N N

NODAE Y Y N N N N N N N N N N N N N N N N N N N N N N

DUMPSCOPE option


RELATED Y Y N N N N N N N N N N N N N N N N N N N N N N

SHUTOPTION option



SYSDUMPING option

NOSYSDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

160 API Structure

diagnostic - dump

INQUIRE TRANDUMPCODE

Table 291. INQUIRE TRANDUMPCODE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TRANDUMPCODE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

CURRENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N




TRANDUMPING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 292. INQUIRE TRANDUMPCODE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SHUTOPTION option



SYSDUMPING option



TRANDUMPING option

NOTRANDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TRANDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Diagnostic services - dump 161

diagnostic - dump

SET TRANDUMPCODE

Table 293. SET TRANDUMPCODE option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TRANDUMPCODE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N





TRANDUMPING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 294. SET TRANDUMPCODE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACTION option



RESET Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SHUTOPTION option



SYSDUMPING option



TRANDUMPING option

NOTRANDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TRANDUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

162 API Structure

diagnostic - trace

Diagnostic services - trace

INQUIRE TRACEDEST

Table 295. INQUIRE TRACEDEST option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AUXSTATUS Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

CURAUXDS Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

GTFSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

INTSTATUS Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SWITCHSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

TABLESIZE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

USERSTATUS N N N N N N N N N N N N N N N N N N N N N Y Y Y

Table 296. INQUIRE TRACEDEST CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AUXSTATUS option

AUXPAUSE Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N N N N

AUXSTART Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

AUXSTOP Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

GTFSTATUS option

GTFSTART Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

GTFSTOP Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

INTSTATUS option

INTSTART Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

INTSTOP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SWITCHSTATUS option

NOSWITCH Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

SWITCHALL Y Y Y Y Y N N N N N N N N N N N N N N N N Y Y Y

SWITCHNEXT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

USERSTATUS option

USEROFF N N N N N N N N N N N N N N N N N N N N N Y Y Y

USERON N N N N N N N N N N N N N N N N N N N N N Y Y Y


diagnostic - trace

SET TRACEDEST

Table 297. SET TRACEDEST option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AUXSTATUS Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

GTFSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

INTSTATUS Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SWITCHACTION Y Y Y Y Y N N N Y N N N T N N N N N N N N Y Y Y

SWITCHSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

TABLESIZE Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

USERSTATUS N N N N N N N N N N N N N N N N N N N N N Y Y Y

Table 298. SET TRACEDEST CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AUXSTATUS option

AUXPAUSE Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N N N N

AUXSTART Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

AUXSTOP Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

GTFSTATUS option

GTFSTART Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

GTFSTOP Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

INTSTATUS option

INTSTART Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

INTSTOP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SWITCHACTION option

SWITCH Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SWITCHSTATUS option

NOSWITCH Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

SWITCHALL Y Y Y Y Y N N N N N N N T N N N N N N N N Y Y Y

SWITCHNEXT Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

USERSTATUS option

USEROFF N N N N N N N N N N N N N N N N N N N N N Y Y Y

USERON N N N N N N N N N N N N N N N N N N N N N Y Y Y

164 API Structure

diagnostic - trace

INQUIRE TRACEFLAG

Table 299. INQUIRE TRACEFLAG option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SINGLESTATUS Y Y Y Y Y N N N N N N N N N N Y N N N N N N N N

SYSTEMSTATUS Y Y Y Y Y N N N N N N N N N N Y N N N N N N N N

TCEXITSTATUS Y Y Y Y Y N N N N N N N N N N Y N N N N N N N N

USERSTATUS Y Y Y Y Y N N N N N N N N N N Y N N N N N N N N

Table 300. INQUIRE TRACEFLAG CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SINGLESTATUS option

SINGLEOFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SINGLEON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSTEMSTATUS option

SYSTEMOFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSTEMON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITSTATUS option

TCEXITALL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITNONE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITSYSTEM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


USERSTATUS option

USEROFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

USERON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Diagnostic services - trace 165

diagnostic - trace

SET TRACEFLAG

Table 301. SET TRACEFLAG option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SINGLESTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSTEMSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

USERSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 302. SET TRACEFLAG CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SINGLESTATUS option

SINGLEOFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SINGLEON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSTEMSTATUS option

SYSTEMOFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYSTEMON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITSTATUS option

TCEXITALL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITALLOFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITNONE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TCEXITSYSTEM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

USERSTATUS option

USEROFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

USERON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

166 API Structure

diagnostic - trace

INQUIRE TRACETYPE

Table 303 (Page 1 of 2). INQUIRE TRACETYPE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SPECIAL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STANDARD Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

AP or APPLICATION Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

CP or CPI Y Y Y Y N N N N N N N N N N N N N N N N N N N N

DC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DD or DIRMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

DI Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DM or DOMAINMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DS or DISPATCHER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DU or DUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EI Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

GC or GLOBALCATLG Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

IC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

IS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

JC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

KC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

KE or KERNEL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LC or LOCALCATLG Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LD or LOADER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LG or LOGGER Y N N N N N N N N N N N N N N N N N N N N N N N

LM or LOCKMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ME or MESSAGE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

MN or MONITOR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NQ or ENQUEUE Y N N N N N N N N N N N N N N N N N N N N N N N

PA or PARAMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PG or PROGMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

RI or RMI Y N N N N N N N N N N N N N N N N N N N N N N N

RM or RECOVERY Y N N N N N N N N N N N N N N N N N N N N N N N

SC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SM or STORAGE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ST or STATISTICS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SZ Y Y Y N N N N N N N N N N N N N N N N N N N N N

TC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TD Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TI or TIMER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TR or TRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


diagnostic - trace

Table 303 (Page 2 of 2). INQUIRE TRACETYPE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

UE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

US or USER Y Y N N N N N N N N N N N N N N N N N N N N N N

XM or TRANMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

XS or SECURITY Y Y N N N N N N N N N N N N N N N N N N N N N N

SET TRACETYPE

Table 304 (Page 1 of 2). SET TRACETYPE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SPECIAL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STANDARD Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

AP or APPLICATION Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

BM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

CP or CPI Y Y Y Y N N N N N N N N N N N N N N N N N N N N

DC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DD or DIRMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

DI Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DM or DOMAINMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DS or DISPATCHER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DU or DUMP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EI Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

GC or GLOBALCATLG Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

IC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

IS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

JC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

KC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

KE or KERNEL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LC or LOCALCATLG Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LD or LOADER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LM or LOCKMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LG or LOGGER Y N N N N N N N N N N N N N N N N N N N N N N N

ME or MESSAGE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

MM or NONITOR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NQ or ENQUEUE Y N N N N N N N N N N N N N N N N N N N N N N N

PA or PARAMGR Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

168 API Structure

diagnostic - trace

Table 304 (Page 2 of 2). SET TRACETYPE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PG or PROGMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

RI or RMI Y N N N N N N N N N N N N N N N N N N N N N N N

RM or RECOVERY Y N N N N N N N N N N N N N N N N N N N N N N N

SC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SM or STORAGE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SP Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ST or STATISTICS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SZ Y Y Y N N N N N N N N N N N N N N N N N N N N N

TC Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TD Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TI or TIMER Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TR or TRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

UE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

US Y Y N N N N N N N N N N N N N N N N N N N N N N

XM or TRANMGR Y Y N N N N N N N N N N N N N N N N N N N N N N

XS or SECURITY Y Y N N N N N N N N N N N N N N N N N N N N N N


diagnostic - trace

170 API Structure


Environment services

INQUIRE SYSTEM

Table 305 (Page 1 of 2). INQUIRE SYSTEM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AKP Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

AMAXTASKS 7 7 Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

APPLID N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

CDSASIZE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

CICSSTATUS Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

CICSSYS Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

CMDPROTECT Y Y N N N N N N N N N N Y N N N N N N N N N N N

COLDSTATUS Y N N N N N N N N N N N N N N N N N N N N N N N

CSCS 6 6 Y N N N N N N N N N N N N N N N N N N N N N

CUSHION 1 1 1 Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

DATEFORM N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

DFLTREMSYS N N N N N N N N N N N N Y N N N N N N N N N N N

DFLTUSER Y Y N N N N N N N N N N Y N N N N N N N N N N N

DSALIMIT Y Y N N N N N N N N N N Y N N N N N N N N N N N

DSASIZE 2 2 2 Y Y N N N N N N N N N N N N N N N N N N N

DTRPROGRAM Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

DUMPING Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

ECDSASIZE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

ECSCS 6 6 Y N N N N N N N N N N N N N N N N N N N N N

ECUSHION 3 3 3 Y Y N N N N N N N N N N N N N N N N N N N

EDSALIMIT Y Y N N N N N N N N N N Y N N N N N N N N N N N

EDSASIZE 4 4 4 Y Y N N N N N N N N N N N N N N N N N N N

ERDSASIZE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

ERSCS 6 6 Y N N N N N N N N N N N N N N N N N N N N N

ESDSASIZE Y Y N N N N N N N N N N Y N N N N N N N N N N N

EUDSASIZE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

EUSCS 6 6 Y N N N N N N N N N N N N N N N N N N N N N

GMMLENGTH Y Y N N N N N N Y N N N Y N N N N N N N N N N N

GMMTEXT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

GMMTRANID Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

INITSTATUS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

INTROINTVL N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

JOBNAME Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

LOCALE N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

MAXREGIONPOOL N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

MAXTASKS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

MAXTASKSHPOOL N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

MROBATCH Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N



Table 305 (Page 2 of 2). INQUIRE SYSTEM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

OPREL Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OPSYS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

PROGAUTOCTLG Y Y N N N N N N N N N N Y N N N N N N N N N N N

PROGAUTOEXIT Y Y N N N N N N N N N N Y N N N N N N N N N N N

PROGAUTOINST Y Y N N N N N N N N N N Y N N N N N N N N N N N

PRTYAGING Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

RDSASIZE Y Y N N N N N N N N N N Y N N N N N N N N N N N

REENTPROTECT Y Y N N N N N N N N N N Y N N N N N N N N N N N

REGIONTHRESH N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

RELEASE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

RLSSTATUS Y N N N N N N N N N N N N N N N N N N N N N N N

RUNAWAY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

SCANDELAY Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

SDSASIZE Y Y N N N N N N N N N N Y N N N N N N N N N N N

SDTRAN Y N N N N N N N N N N N N N N N N N N N N N N N

SECURITYMGR Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

SHUTSTATUS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SOSSTATUS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

STALL 6 6 5 5 5 Y Y Y Y Y Y Y N N N N N N N N N N N N

STARTUP Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

STARTUPDATE Y Y N N N N N N Y N N N Y N N N N N N N N N N N

STOREPROTECT Y Y Y N N N N N N N N N Y N N N N N N N N N N N

SYSID N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

TASKTHRESH N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

TIME Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

TRANISOLATE Y Y N N N N N N N N N N Y N N N N N N N N N N N

UDSASIZE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

USCS 6 6 Y N N N N N N N N N N N N N N N N N N N N N

XRFSTATUS Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

Notes:

1. Replaced by the CSCS option. The CUSHION option is mapped to the same argumentposition as the CSCS option. CUSHION should be treated as an undiagnosed synonym forCSCS; see also DATASET and FILE. However the option is diagnosed as not valid and isignored.

2. Replaced by the CDSASIZE option. The DSASIZE option is mapped to the same argumentposition as the CDSASIZE option. DSASIZE should be treated as an undiagnosed synonymfor CDSASIZE; see also DATASET and FILE. However the option is diagnosed as not validand is ignored.

3. Replaced by the ECSCS option. The ECUSHION option is mapped to the same argumentposition as the ECSCS option. ECUSHION should be treated as an undiagnosed synonym forECSCS; see also DATASET and FILE. However the option is diagnosed as not valid and isignored.

4. Replaced by the ECDSASIZE option. The EDSASIZE option is mapped to the same argumentposition as the ECDSASIZE option. EDSASIZE should be treated as an undiagnosed

172 API Structure


synonym for ECDSASIZE; see also DATASET and FILE. However the option is diagnosed asnot valid and is ignored.

5. Ignored. The option is diagnosed as no longer supported and is ignored.6. Ignored at execution time. The option is not diagnosed as no longer supported but is

translated.7. Returns the same value as the MAXTASKS option. The option is not diagnosed as no longer

supported but is translated.

Table 306 (Page 1 of 2). INQUIRE SYSTEM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CICSSTATUS option

ACTIVE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

FIRSTQUIESCE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

FINALQUIESCE Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

STARTUP Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

CMDPROTECT option

CMDPROT Y Y N N N N N N N N N N N N N N N N N N N N N N

NOCMDPROT Y Y N N N N N N N N N N Y N N N N N N N N N N N

COLDSTATUS option

COLD Y N N N N N N N N N N N N N N N N N N N N N N N

INITIAL Y N N N N N N N N N N N N N N N N N N N N N N N


DUMPING option

NOSYSDUMP Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

SYSDUMP Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

INITSTATUS option

FIRSTINIT Y Y N N N N N N N N N N N N N N N N N N N N N N

SECONDINIT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

THIRDINIT Y Y N N N N N N Y N N N N N N N N N N N N N N N

INITCOMPLETE Y Y N N N N N N Y N N N Y N N N N N N N N N N N

PROGAUTOCTLG option

CTLGALL Y Y N N N N N N N N N N N N N N N N N N N N N N

CTLGMODIFY Y Y N N N N N N N N N N N N N N N N N N N N N N

CTLGNONE Y Y N N N N N N N N N N Y N N N N N N N N N N N

PROGAUTOINST option

AUTOACTIVE Y Y N N N N N N N N N N Y N N N N N N N N N N N

AUTOINACTIVE Y Y N N N N N N N N N N N N N N N N N N N N N N

REENTPROTECT option

NOREENTPROT Y Y N N N N N N N N N N N N N N N N N N N N N N

REENTPROT Y Y N N N N N N N N N N Y N N N N N N N N N N N

RLSSTATUS option


RLSACTIVE Y N N N N N N N N N N N N N N N N N N N N N N N

RLSINACTIVE Y N N N N N N N N N N N N N N N N N N N N N N N

SECURITYMGR option

CICSSECURITY N N N N Y N N N N N N N Y N N N N N N N N N N N

EXTSECURITY Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N



Table 306 (Page 2 of 2). INQUIRE SYSTEM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

NOSECURITY Y Y Y Y N N N N Y N N N N N N N N N N N N N N N

SHUTSTATUS option

CANCELLED Y Y N N N N N N N N N N N N N N N N N N N N N N

CONTROLSHUT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SHUTDOWN Y Y N N N N N N Y N N N Y N N N N N N N N N N N


SOSSTATUS option

NOTSOS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SOS Y Y N N N N N N N N N N N N N N N N N N N N N N

SOSABOVE Y Y N N N N N N N N N N N N N N N N N N N N N N

SOSBELOW Y Y N N N N N N Y N N N N N N N N N N N N N N N

STARTUP option

COLDSTART Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

EMERGENCY Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

LOGTERM N Y Y Y N N N N N N N N N N N N N N N N N N N N

WARMSTART Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

STOREPROTECT option

ACTIVE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

INACTIVE Y Y Y N N N N N N N N N N N N N N N N N N N N N

TRANISOLATE option

ACTIVE Y Y N N N N N N N N N N Y N N N N N N N N N N N

INACTIVE Y Y N N N N N N N N N N N N N N N N N N N N N N

XRFSTATUS option

PRIMARY Y Y Y Y N N N N Y N N N N N N N N N N N N N N N

TAKEOVER Y Y Y Y N N N N Y N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

174 API Structure


SET SYSTEM

Table 307. SET SYSTEM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AKP Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

AMAXTASKS 4 4 Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

CSCS 4 4 Y N N N N N N N N N N N N N N N N N N N N N

CUSHION 1 1 1 Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

DFLTREMSYS N N N N N N N N N N N N Y N N N N N N N N N N N

DSALIMIT Y Y N N N N N N N N N N T N N N N N N N N N N N

DTRPROGRAM Y Y Y Y Y N N N Y Y Y N T N N N N N N N N N N N

DUMPING Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

ECSCS 4 4 Y N N N N N N N N N N N N N N N N N N N N N

ECUSHION 2 2 2 Y Y N N N N N N N N N N N N N N N N N N N

EDSALIMIT Y Y N N N N N N N N N N T N N N N N N N N N N N

ERSCS 4 4 Y N N N N N N N N N N N N N N N N N N N N N

EUSCS 4 4 Y N N N N N N N N N N N N N N N N N N N N N

GMMLENGTH Y Y N N N N N N Y N N N T N N N N N N N N N N N

GMMTEXT Y Y N N N N N N Y N N N T N N N N N N N N N N N

MAXTASKS Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

MROBATCH Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

NEWMAXTASKS Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

PROGAUTOCTLG Y Y N N N N N N N N N N T N N N N N N N N N N N

PROGAUTOEXIT Y Y N N N N N N N N N N T N N N N N N N N N N N

PROGAUTOINST Y Y N N N N N N N N N N T N N N N N N N N N N N

PRTYAGING Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

RUNAWAY Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

SCANDELAY Y Y Y Y Y N N N Y N N N T N N N N N N N N N N N

STALL 4 4 3 3 3 Y Y Y Y Y Y Y N N N N N N N N N N N N

TIME Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

USCS 4 4 Y N N N N N N N N N N N N N N N N N N N N N

Notes:

1. Replaced by the CSCS option. The CUSHION option is mapped to the same argumentposition as the CSCS option. CUSHION should be treated as an undiagnosed synonym forCSCS; see also DATASET and FILE. However the option is diagnosed as not valid and isignored.

2. Replaced by the ECSCS option. The ECUSHION option is mapped to the same argumentposition as the ECSCS option. ECUSHION should be treated as an undiagnosed synonym forECSCS; see also DATASET and FILE. However the option is diagnosed as not valid and isignored.

3. Ignored. The option is diagnosed as no longer supported and is ignored.4. Ignored at execution time. The option is not diagnosed as no longer supported but is

translated.



Table 308. SET SYSTEM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DUMPING option

NOSYSDUMP Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

SYSDUMP Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

PROGAUTOCTLG option

CTLGALL Y Y N N N N N N N N N N T N N N N N N N N N N N

CTLGMODIFY Y Y N N N N N N N N N N T N N N N N N N N N N N

CTLGNONE Y Y N N N N N N N N N N Y N N N N N N N N N N N

PROGAUTOINST option

AUTOACTIVE Y Y N N N N N N N N N N Y N N N N N N N N N N N

INAUTOACTIVE Y Y N N N N N N N N N N T N N N N N N N N N N N

176 API Structure

exits

Exits

INQUIRE EXITPROGRAM

Table 309. INQUIRE EXITPROGRAM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

EXITPROGRAM Y Y N N N N N N N N N N N N N N N N N N N N N N

CONNECTST Y Y N N N N N N N N N N N N N N N N N N N N N N

ENTRY Y Y N N N N N N N N N N N N N N N N N N N N N N

ENTRYNAME Y Y N N N N N N N N N N N N N N N N N N N N N N

EXIT Y Y N N N N N N N N N N N N N N N N N N N N N N

FORMATEDFST Y Y N N N N N N N N N N N N N N N N N N N N N N

GAENTRYNAME Y Y N N N N N N N N N N N N N N N N N N N N N N

GALENGTH Y Y N N N N N N N N N N N N N N N N N N N N N N

GAUSECOUNT Y Y N N N N N N N N N N N N N N N N N N N N N N

INDOUBTST Y N N N N N N N N N N N N N N N N N N N N N N N

NUMEXITS Y Y N N N N N N N N N N N N N N N N N N N N N N

QUALIFIER Y N N N N N N N N N N N N N N N N N N N N N N N

SHUTDOWNST Y Y N N N N N N N N N N N N N N N N N N N N N N

SPIST Y N N N N N N N N N N N N N N N N N N N N N N N

STARTSTATUS Y Y N N N N N N N N N N N N N N N N N N N N N N

TALENGTH Y Y N N N N N N N N N N N N N N N N N N N N N N

TASKSTARTST Y Y N N N N N N N N N N N N N N N N N N N N N N

Table 310 (Page 1 of 2). INQUIRE EXITPROGRAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONNECTST option

CONNECTED Y Y N N N N N N N N N N N N N N N N N N N N N N

NOTCONNECTED Y Y N N N N N N N N N N N N N N N N N N N N N N

UNKNOWN Y N N N N N N N N N N N N N N N N N N N N N N N


FORMATEDFST option

FORMATEDF Y Y N N N N N N N N N N N N N N N N N N N N N N

NOFORMATEDF Y Y N N N N N N N N N N N N N N N N N N N N N N


INDOUBTST option




exits

Table 310 (Page 2 of 2). INQUIRE EXITPROGRAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


SHUTDOWNST option

NOSHUTDOWN Y Y N N N N N N N N N N N N N N N N N N N N N N

SHUTDOWN Y Y N N N N N N N N N N N N N N N N N N N N N N


SPIST option

NOSPI Y N N N N N N N N N N N N N N N N N N N N N N N

SPI Y N N N N N N N N N N N N N N N N N N N N N N N


STARTSTATUS option

STARTED Y Y N N N N N N N N N N N N N N N N N N N N N N

STOPPED Y Y N N N N N N N N N N N N N N N N N N N N N N

TASKSTARTST option

NOTASKSTART Y Y N N N N N N N N N N N N N N N N N N N N N N

TASKSTART Y Y N N N N N N N N N N N N N N N N N N N N N N


Table 311. INQUIRE EXITPROGRAM browse option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

EXIT Y Y N N N N N N N N N N N N N N N N N N N N N N

178 API Structure

file control

File control

INQUIRE FILE

Table 312. INQUIRE FILE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

FILE Y Y Y Y Y Y Y 1 Y Y Y 1 Y Y Y Y Y Y Y Y Y Y Y Y

ACCESSMETHOD Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

ADD Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

BASEDSNAME Y Y Y Y Y Y Y 2 Y Y Y 2 Y N N N N N N N N N N N

BASENAME N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

BLOCKFORMAT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

BLOCKKEYLEN Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

BLOCKSIZE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

BROWSE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

DELETE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

DISPOSITION Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

DSNAME Y Y Y Y Y Y Y 3 Y Y Y 3 Y N N N N N N N N Y Y Y

EMPTYSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

ENABLESTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

EXCLUSIVE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

FILESERVER N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

FWDRECSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

INDEXNAME N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

JOURNALNUM Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

KEYLENGTH Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

KEYPOSITION Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

LSRPOOLID Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

MAXNUMRECS Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

OBJECT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

OPENSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

READ Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

READINTEG Y N N N N N N N N N N N N N N N N N N N N N N N

RECORDFORMAT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

RECORDSIZE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

RECOVSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

RELTYPE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

REMOTENAME Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

REMOTESYSTEM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

RLSACCESS Y N N N N N N N N N N N N N N N N N N N N N N N

STRINGS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

TABLE Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

TYPE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UPDATE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


file control

Notes:


2. Implemented as the BASENAME option; later releases allow BASENAME as an undiagnosedsynonym for BASEDSNAME.

3. Implemented as the OBJECTNAME option; later releases allow OBJECTNAME as anundiagnosed synonym for DSNAME.

OS/VS 1.7 also supports the CATALOGNAME option; however the option has been removed from theCICS system programming interface.

Table 313 (Page 1 of 3). INQUIRE FILE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACCESSMETHOD option

BDAM Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

REMOTE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

SFS N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

VSAM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

ADD option

ADDABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

NOTADDABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


BLOCKFORMAT option

BLOCKED Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

UNBLOCKED Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N


BROWSE option

BROWSABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

NOTBROWSABLE Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y Y Y Y


DELETE option

DELETABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

NOTDELETABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


DISPOSITION option

OLD Y Y Y Y Y Y Y Y N N N N Y N N N N N N N N N N N

SHARE Y Y Y Y Y Y Y Y N N N N Y N N N N N N N N N N N


EMPTYSTATUS option

EMPTYREQ Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y Y Y Y

NOEMPTYREQ Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


ENABLESTATUS option

DISABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

DISABLING Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

ENABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

UNENABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N N N

180 API Structure

file control


CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

UNENABLING Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y N N N


EXCLUSIVE option

EXCTL Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

NOEXCTL Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N


FWDRECSTATUS option

FWDRECOVABLE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTFWDRCVBLE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N


OBJECT option

BASE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

PATH Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N


OPENSTATUS option

CLOSED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

CLOSEREQUEST Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y Y Y Y

CLOSING Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

OPEN Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

OPENING Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y N N N


READ option

NOTREADABLE Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y Y Y Y

READABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


READINTEG option

CONSISTENT Y N N N N N N N N N N N N N N N N N N N N N N N

REPEATABLE Y N N N N N N N N N N N N N N N N N N N N N N N

UNCOMMITTED Y N N N N N N N N N N N N N N N N N N N N N N N


RECORDFORMAT option

FIXED Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UNDEFINED Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

VARIABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


RECOVSTATUS option

NOTRECOVABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

RECOVERABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y


RELTYPE option

BLK Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

DEC Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

HEX Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N


RLSACCESS option

File control 181

file control


CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

NOTRLS Y N N N N N N N N N N N N N N N N N N N N N N N

RLS Y N N N N N N N N N N N N N N N N N N N N N N N


TABLE option

CICSTABLE Y Y Y N N N N N Y N N N N N N N N N N N N N N N

NOTTABLE Y Y Y N N N N N Y N N N Y N N N N N N N N N N N

USERTABLE Y Y Y N N N N N Y N N N N N N N N N N N N N N N


TYPE option

ESDS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

KEYED Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

KSDS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

NOTKEYED Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

RRDS Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

VRRDS Y N N N N N N N N N N N N N N N N N N N N N N N


UPDATE option

NOTUPDATABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

UPDATABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y


182 API Structure

file control

SET FILE

Table 314. SET FILE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

FILE Y Y Y Y Y Y Y 1 Y Y Y 1 Y Y Y Y Y Y Y Y Y Y Y Y

ADD Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y Y Y Y

BASENAME N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

BROWSE Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y Y Y Y

BUSY Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

DELETE Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y Y Y Y

DISPOSITION Y Y Y Y Y Y Y Y T T T T T N N N N N N N N N N N

DSNAME Y Y Y Y Y Y Y 2 T T T 2 T N N N N N N N N N N N

EMPTY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

EMPTYSTATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

ENABLESTATUS Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

EXCLUSIVE Y Y Y Y Y N N N Y N N N T N N N N N N N N N N N

FILESERVER N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

INDEXNAME N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

LSRPOOLID Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

MAXNUMRECS Y Y Y N N N N N N N N N T N N N N N N N N N N N

OPENSTATUS Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

READ Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y Y Y Y

READINTEG Y N N N N N N N N N N N N N N N N N N N N N N N

RESET N N N N N N N N N N N N Y Y Y Y N N N N N N N N


STRINGS Y Y Y Y Y Y Y Y Y Y Y Y T N N N N N N N N N N N

TABLE Y Y Y N N N N N N N N N T N N N N N N N N N N N

UPDATE Y Y Y Y Y Y Y Y Y Y Y Y T N N N Y Y Y Y Y Y Y Y

Notes:


2. Implemented as the OBJECTNAME option; later releases allow OBJECTNAME as anundiagnosed synonym for DSNAME.

OS/VS 1.7 also supports the CATALOGNAME option; however the option has been removed from theCICS system programming interface.

File control 183

file control

Table 315 (Page 1 of 2). SET FILE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ADD option

ADDABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

NOTADDABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

BROWSE option

BROWSABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N 1 1 1 1 1 Y Y Y

NOTBROWSABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

BUSY option

FORCE Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y N N N N N N N N N N

NOWAIT Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

WAIT Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

DELETE option

DELETABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

NOTDELETABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

DISPOSTION option

OLD Y Y Y Y Y Y Y Y N N N N T N N N N N N N N N N N

SHARE Y Y Y Y Y Y Y Y N N N N T N N N N N N N N N N N

EMPTYSTATUS option

EMPTYREQ Y Y Y Y Y Y Y Y Y Y Y Y T Y Y Y 1 1 1 1 1 Y Y Y

NOEMPTYREQ Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

ENABLESTATUS option

DISABLED Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

ENABLED Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

EXCLUSIVE option

EXCTL Y Y Y Y Y N N N Y N N N T N N N N N N N N N N N

NOEXCTL Y Y Y Y Y N N N Y N N N T N N N N N N N N N N N

OPENSTATUS option

CLOSED Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

OPEN Y Y Y Y Y 2 2 2 Y 2 2 2 Y Y Y Y 2 2 2 2 2 Y Y Y

READ option

NOTREADABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

READABLE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N 1 1 1 1 1 Y Y Y

READINTEG option

CONSISTENT Y N N N N N N N N N N N N N N N N N N N N N N N

REPEATABLE Y N N N N N N N N N N N N N N N N N N N N N N N

UNCOMMITTED Y N N N N N N N N N N N N N N N N N N N N N N N

RLSACCESS option




TABLE option

CICSTABLE Y Y Y N N N N N N N N N T N N N N N N N N N N N

NOTABLE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

USERTABLE Y Y Y N N N N N N N N N T N N N N N N N N N N N

UPDATE option

NOTUPDATABLE Y Y Y Y Y Y Y Y Y Y Y Y T N N N 1 1 1 1 1 Y Y Y

184 API Structure

file co

ntro

l

Table 315 (P

age 2 of 2). SE

TF

ILEC

VD

Asupport

acrossC

ICS

platforms

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

UP

DA

TA

BLE

YY

YY

YY

YY

YY

YY

TN

NN

11

11

1Y

YY

No

tes:

1.S

pecifiable only as a CV

DA

.2.

Specifiable only as an option.

File control

185

file control

186 API Structure

journal control

Journal control

INQUIRE JOURNALMODEL

Table 316. INQUIRE JOURNALMODEL option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

JOURNALMODEL Y N N N N N N N N N N N N N N N N N N N N N N N

JOURNALNAME Y N N N N N N N N N N N N N N N N N N N N N N N

STREAMNAME Y N N N N N N N N N N N N N N N N N N N N N N N

TYPE Y N N N N N N N N N N N N N N N N N N N N N N N

Table 317. INQUIRE JOURNALMODEL CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TYPE option

DUMMY Y N N N N N N N N N N N N N N N N N N N N N N N

MVS Y N N N N N N N N N N N N N N N N N N N N N N N

SMF Y N N N N N N N N N N N N N N N N N N N N N N N

INQUIRE JOURNALNAME

Table 318. INQUIRE JOURNALNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


STATUS Y N N N N N N N N N N N N N N N N N N N N N N N




journal control

Table 319. INQUIRE JOURNALNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

STATUS option

DISABLED Y N N N N N N N N N N N N N N N N N N N N N N N

ENABLED Y N N N N N N N N N N N N N N N N N N N N N N N

FAILED Y N N N N N N N N N N N N N N N N N N N N N N N

TYPE option

DUMMY Y N N N N N N N N N N N N N N N N N N N N N N N

MVS Y N N N N N N N N N N N N N N N N N N N N N N N

SMF Y N N N N N N N N N N N N N N N N N N N N N N N

SET JOURNALNAME

Table 320. SET JOURNALNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


ACTION Y N N N N N N N N N N N N N N N N N N N N N N N


Table 321. SET JOURNALNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACTION option

FLUSH Y N N N N N N N N N N N N N N N N N N N N N N N

RESET Y N N N N N N N N N N N N N N N N N N N N N N N

STATUS option

DISABLED Y N N N N N N N N N N N N N N N N N N N N N N N

ENABLED Y N N N N N N N N N N N N N N N N N N N N N N N

188 API Structure

journal control

INQUIRE JOURNALNUM

Table 322. INQUIRE JOURNALNUM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

JOURNALNUM 1 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

ARCHSTATUS 1 Y Y Y Y N N N N N N N N N N N N N N N N N N N

CURRENTVOL 1 Y Y Y Y N N N Y N N N N N N N N N N N N N N N

DISKASTATUS 1 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

DISKBSTATUS 1 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

DISKXSTATUS 1 Y Y Y Y N N N N N N N N N N N N N N N N N N N

JTYPE 1 Y Y Y Y N N N Y N N N N N N N N N N N N Y Y Y

OLDESTPART 1 Y Y Y Y N N N Y N N N N N N N N N N N N N N N

OPENSTATUS 1 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

Table 323 (Page 1 of 2). INQUIRE JOURNALNUM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ARCHSTATUS option

AUTOARCH N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOAUTOARCH N Y Y Y Y N N N N N N N N N N N N N N N N N N N

REVERTED N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTAPPLIC N Y Y Y Y N N N N N N N N N N N N N N N N N N N

DISKASTATUS option

CURRENT N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

NOTREADY N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

READY N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

NOTAPPLIC N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

DISKBSTATUS option

CURRENT N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

NOTREADY N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

READY N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y N N N

NOTAPPLIC N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

DISKXSTATUS option

CURRENT N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTREADY N Y Y Y Y N N N N N N N N N N N N N N N N N N N

READY N Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTAPPLIC N Y Y Y Y N N N N N N N N N N N N N N N N N N N

JTYPE option

DISK1 N Y Y Y Y N N N Y N N N N N N N N N N N N Y Y Y

DISK2 N Y Y Y Y N N N Y N N N N N N N N N N N N Y Y Y

Journal control 189

journal control

Table 323 (Page 2 of 2). INQUIRE JOURNALNUM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DISK2PAUSE N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

SMF N Y Y Y Y N N N N N N N N N N N N N N N N N N N

TAPE1 N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

TAPE2 N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

OPENSTATUS option

CLOSED N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

OPENINPUT N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

OPENOUTPUT N Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

Note:

1. This command is replaced by the INQUIRE JOURNALNAME command. It will be translatedwith a warning and will return JIDERR on execution.

SET JOURNALNUM

Table 324. SET JOURNALNUM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

JOURNALNUM 2 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

OPENSTATUS 2 Y Y Y Y N N N Y N N N N N N N Y Y Y Y Y Y Y Y

Table 325. SET JOURNALNUM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

OPENSTATUS option

ADVANCE N Y Y Y Y N N N Y N N N N N N N 1 1 1 1 1 N N N

CLOSED N Y Y Y Y N N N Y N N N N N N N 1 1 1 1 1 Y Y Y

CLOSELEAVE N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

OPENOUTPUT N Y Y Y Y N N N Y N N N N N N N 1 1 1 1 1 Y Y Y

Notes:

1. Specifiable only as a CVDA.

190 API Structure

journal control

2. This command is replaced by the SET JOURNALNAME command. It will be translated with awarning and will return JIDERR on execution.

INQUIRE STREAMNAME

Table 326. INQUIRE STREAMNAME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2



SYSTEMLOG Y N N N N N N N N N N N N N N N N N N N N N N N

USECOUNT Y N N N N N N N N N N N N N N N N N N N N N N N

Table 327. INQUIRE STREAMNAME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

STATUS option

FAILED Y N N N N N N N N N N N N N N N N N N N N N N N

OK Y N N N N N N N N N N N N N N N N N N N N N N N

SYSTEMLOG option

NOSYSLOG Y N N N N N N N N N N N N N N N N N N N N N N N

SYSLOG Y N N N N N N N N N N N N N N N N N N N N N N N

Journal control 191

journal control

192 API Structure

monitoring

Monitoring

INQUIRE MONITOR

Table 328. INQUIRE MONITOR option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONVERSEST Y Y N N N N N N N N N N N N N N N N N N N N N N

EVENTCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EXCEPTCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FREQUENCY Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYMIN Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYSEC Y Y N N N N N N N N N N N N N N N N N N N N N N

PERFCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYNCPOINTST Y Y N N N N N N N N N N N N N N N N N N N N N N

SUBSYSTEMID Y Y N N N N N N N N N N N N N N N N N N N N N N

TIME Y Y N N N N N N N N N N N N N N N N N N N N N N

Table 329 (Page 1 of 2). INQUIRE MONITOR CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONVERSEST option

CONVERSE Y Y N N N N N N N N N N N N N N N N N N N N N N

NOCONVERSE Y Y N N N N N N N N N N N N N N N N N N N N N N

EVENTCLASS option

EVENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOEVENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EXCEPTCLASS option

EXCEPT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOEXCEPT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PERFCLASS option

NOPERF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PERF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STATUS option

OFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYNCPOINTST option

NOSYNCPOINT Y Y N N N N N N N N N N N N N N N N N N N N N N


monitoring

Table 329 (Page 2 of 2). INQUIRE MONITOR CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

SYNCPOINT Y Y N N N N N N N N N N N N N N N N N N N N N N

TIME option

GMT Y Y N N N N N N N N N N N N N N N N N N N N N N


SET MONITOR

Table 330. SET MONITOR option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONVERSEST Y Y N N N N N N N N N N N N N N N N N N N N N N

EVENTCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EXCEPTCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FREQUENCY Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYHRS Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYMIN Y Y N N N N N N N N N N N N N N N N N N N N N N

FREQUENCYSEC Y Y N N N N N N N N N N N N N N N N N N N N N N

PERFCLASS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYNCPOINTST Y Y N N N N N N N N N N N N N N N N N N N N N N

Table 331 (Page 1 of 2). SET MONITOR CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CONVERSEST option

NOCONVERSE Y Y N N N N N N N N N N N N N N N N N N N N N N

CONVERSE Y Y N N N N N N N N N N N N N N N N N N N N N N

EVENTCLASS option

EVENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOEVENT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EXCEPTCLASS option

EXCEPT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOEXCEPT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PERFCLASS option

194 API Structure

monitoring

Table 331 (Page 2 of 2). SET MONITOR CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

NOPERF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PERF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

STATUS option

OFF Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

ON Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SYNCPOINTST option

NOSYNCPOINT Y Y N N N N N N N N N N N N N N N N N N N N N N

SYNCPOINT Y Y N N N N N N N N N N N N N N N N N N N N N N

Monitoring 195

monitoring

196 API Structure

program control

Program control

INQUIRE PROGRAM

Table 332. INQUIRE PROGRAM option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PROGRAM Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

CEDFSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

COBOLTYPE Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

COPY Y Y N N N N N N N N N N Y N N N N N N N N N N N

DATALOCATION Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

ENTRYPOINT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

EXECKEY Y Y Y N N N N N N N N N Y N N N N N N N N N N N

EXECUTIONSET Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

HOLDSTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

LANGUAGE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

LENGTH Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

LOADPOINT Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

LPASTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

PROGTYPE Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

REMOTENAME Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

REMOTESYSTEM Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

RESCOUNT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

SHARESTATUS Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

STATUS Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

SVASTATUS N N N N N N N N Y N N N N N N N N N N N N N N N

TRANSID Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

USECOUNT Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

Table 333 (Page 1 of 3). INQUIRE PROGRAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CEDFSTATUS option

CEDF Y Y Y Y N N N N N N N N Y N N N N N N N N Y Y Y

NOCEDF Y Y Y Y N N N N N N N N Y N N N N N N N N Y Y Y

NOTAPPLIC Y Y Y N N N N N N N N N Y N N N N N N N N Y Y Y

COBOLTYPE option

COBOL Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

COBOLII Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N


program control

Table 333 (Page 2 of 3). INQUIRE PROGRAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

NOTINIT Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

NOTAPPLIC Y Y Y Y N N N N Y N N N Y N N N N N N N N Y Y Y

COPY option

NOTREQUIRED Y Y N N N N N N N N N N Y N N N N N N N N N N N

REQUIRED Y Y N N N N N N N N N N N N N N N N N N N N N N

DATALOCATION option

ANY Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

BELOW Y Y Y Y N N N N Y N N N N N N N N N N N N N N N


EXECKEY option

CICSEXECKEY Y Y Y N N N N N N N N N Y N N N N N N N N N N N

USEREXECKEY Y Y Y N N N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y N N N N N N N N N Y N N N N N N N N N N N

EXECUTIONSET option

DPLSUBSET Y Y Y N N N N N Y Y N N N N N N N N N N N Y Y Y

FULLAPI Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

NOTAPPLIC Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

HOLDSTATUS option

HOLD Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

NOHOLD Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

NOTAPPLIC Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

LANGUAGE option

ASSEMBLER Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

C Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N Y N N

COBOL Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N Y Y Y

LE370 Y Y Y Y N N N N Y N N N N N N N N N N N N N N N

NOTDEFINED N N N N N N N N N N N N Y N N N N N N N N N N N

PLI Y Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N

RPG Y Y Y Y N Y Y Y Y Y Y Y N N N N N N N N N N N N

NOTAPPLIC Y Y Y N N N N N Y Y N N Y N N N N N N N N N N N

LPASTATUS option

LPA Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

NOTLPA Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


PROGTYPE option

PROGRAM Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y Y Y Y

MAP Y Y Y Y Y Y Y Y Y Y Y Y N N N N Y Y Y Y Y Y Y Y

PARTITIONSET Y Y Y Y Y Y Y Y Y Y Y Y N N N N N N N N N N N N

SHARESTATUS option

PRIVATE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SHARED Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y N N N N N N N N N Y N N N N N N N N N N N

STATUS option



198 API Structure

p

rog

ram co

ntro

l

Table 333 (P

age 3 of 3). INQ

UIR

EP

RO

GR

AM

CV

DA

supportacross

CIC

Splatform

s

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

SV

AS

TA

TU

S option

NO

TS

VA

NN

NN

NN

NN

YN

NN

NN

NN

NN

NN

NN

NN

SV

AN

NN

NN

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

NO

TA

PP

LICN

NN

NN

NN

NY

NN

NN

NN

NN

NN

NN

NN

N

Table 334. IN

QU

IRE

PR

OG

RA

Mbrow

seoption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

AT

YY

YY

YN

NN

NN

NN

YN

NN

NN

NN

NN

NN

SE

TP

RO

GR

AM

Table 335. S

ET

PR

OG

RA

Moption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

PR

OG

RA

MY

YY

YY

YY

YY

YY

YY

YY

YY

YY

YY

YY

Y

CE

DF

ST

AT

US

YY

YY

YN

NN

NN

NN

YN

NN

NN

NN

NY

YY

CO

PY

YY

YY

YN

NN

NN

NN

YN

NN

NN

NN

NY

YY

EX

EC

UT

ION

SE

TY

YY

NN

NN

NY

YN

NT

NN

NN

NN

NN

YY

Y

SH

AR

ES

TA

TU

SY

YY

YY

NN

NN

NN

NT

NN

NN

NN

NN

NN

N

ST

AT

US

YY

YY

YY

YY

YY

YY

YY

YY

YY

YY

YY

YY

VE

RS

ION

YY

YY

YN

NN

NN

NN

TN

NN

NN

NN

NN

NN

Table 336 (P

age 1 of 2). SE

TP

RO

GR

AM

CV

DA

supportacross

CIC

Splatform

s

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

CE

DF

ST

AT

US

option

CE

DF

YY

YY

YN

NN

NN

NN

YN

NN

NN

NN

NY

YY

NO

CE

DF

YY

YY

YN

NN

NN

NN

YN

NN

NN

NN

NY

YY

Program

control199

program control

Table 336 (Page 2 of 2). SET PROGRAM CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

COPY option

NEWCOPY Y Y Y Y Y 2 2 2 2 2 2 2 Y N N N 2 2 2 2 2 Y Y Y

PHASEIN Y Y Y Y Y N N N N N N N Y N N N N N N N N Y Y Y

EXECUTIONSET option

DPLSUBSET Y Y Y N N N N N Y Y N N T N N N N N N N N Y Y Y

FULLAPI Y Y Y N N N N N Y Y N N Y N N N N N N N N Y Y Y

SHARESTATUS option

PRIVATE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

SHARED Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

STATUS option

DISABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

ENABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

VERSION option

NEWCOPY Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

OLDCOPY Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Notes:


200 API Structure

queued requests

Queued requests

INQUIRE REQID

Table 337. INQUIRE REQID option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

REQID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

AFTER Y Y N N N N N N Y N N N Y N N N N N N N N N N N

AT Y Y N N N N N N Y N N N Y N N N N N N N N N N N

FMHSTATUS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

HOURS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

INTERVAL Y Y N N N N N N Y N N N Y N N N N N N N N N N N

LENGTH Y Y N N N N N N Y N N N Y N N N N N N N N N N N

MINUTES Y Y N N N N N N Y N N N Y N N N N N N N N N N N

QUEUE Y Y N N N N N N Y N N N Y N N N N N N N N N N N

REQTYPE Y Y N N N N N N Y N N N Y N N N N N N N N N N N

RTERMID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

RTRANSID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SECONDS Y Y N N N N N N Y N N N Y N N N N N N N N N N N

SET Y Y N N N N N N Y N N N Y N N N N N N N N N N N

TERMID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

TIME Y Y N N N N N N Y N N N Y N N N N N N N N N N N

TRANSID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

USERID Y Y N N N N N N Y N N N Y N N N N N N N N N N N

Table 338. INQUIRE REQID CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

FMHSTATUS option

FMH Y Y N N N N N N Y N N N N N N N N N N N N N N N

NOFMH Y Y N N N N N N Y N N N Y N N N N N N N N N N N


REQTYPE option

DELAY Y Y N N N N N N Y N N N Y N N N N N N N N N N N

POST Y Y N N N N N N Y N N N Y N N N N N N N N N N N

ROUTE Y Y N N N N N N N N N N N N N N N N N N N N N N

START Y Y N N N N N N Y N N N Y N N N N N N N N N N N


queued requests

202 API Structure

recovery management

Recovery management

INQUIRE UOW

Table 339. INQUIRE UOW option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

UOW Y N N N N N N N N N N N N N N N N N N N N N N N

AGE Y N N N N N N N N N N N N N N N N N N N N N N N

LINK Y N N N N N N N N N N N N N N N N N N N N N N N

NETNAME Y N N N N N N N N N N N N N N N N N N N N N N N

NETUOWID Y N N N N N N N N N N N N N N N N N N N N N N N

SYSID Y N N N N N N N N N N N N N N N N N N N N N N N

TASKID Y N N N N N N N N N N N N N N N N N N N N N N N

TERMID Y N N N N N N N N N N N N N N N N N N N N N N N

TRANSID Y N N N N N N N N N N N N N N N N N N N N N N N

UOWSTATE Y N N N N N N N N N N N N N N N N N N N N N N N

USERID Y N N N N N N N N N N N N N N N N N N N N N N N

WAITCAUSE Y N N N N N N N N N N N N N N N N N N N N N N N

WAITSTATE Y N N N N N N N N N N N N N N N N N N N N N N N

Table 340 (Page 1 of 2). INQUIRE UOW CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

UOWSTATE option



HBACKOUT Y N N N N N N N N N N N N N N N N N N N N N N N

HCOMMIT Y N N N N N N N N N N N N N N N N N N N N N N N

INDOUBT Y N N N N N N N N N N N N N N N N N N N N N N N

INFLIGHT Y N N N N N N N N N N N N N N N N N N N N N N N

WAITCAUSE option

CONNECTION Y N N N N N N N N N N N N N N N N N N N N N N N

DATASET Y N N N N N N N N N N N N N N N N N N N N N N N

RLSSERVER Y N N N N N N N N N N N N N N N N N N N N N N N

WAITCOMMIT Y N N N N N N N N N N N N N N N N N N N N N N N

WAITFORGET Y N N N N N N N N N N N N N N N N N N N N N N N

WAITRMI Y N N N N N N N N N N N N N N N N N N N N N N N

WAITSTATE option

ACTIVE Y N N N N N N N N N N N N N N N N N N N N N N N


reco

very man

agem

ent

Table 340 (P

age 2 of 2). INQ

UIR

EU

OW

CV

DA

supportacross

CIC

Splatform

s

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

SH

UN

TE

DY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

WA

ITIN

GY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

SE

TU

OW

Table 341. S

ET

UO

Woption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

UO

WY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

UO

WS

TA

TE

YN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

Table 342. S

ET

UO

WC

VD

Asupport

acrossC

ICS

platforms

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

UO

WS

TA

TE

option

CO

MM

ITY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

BA

CK

OU

TY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

FO

RC

EY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

204A

PI S

tructure

recovery management

INQUIRE UOWDSNFAIL

Table 343. INQUIRE UOWDSNFAIL option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CAUSE Y N N N N N N N N N N N N N N N N N N N N N N N

DSNAME Y N N N N N N N N N N N N N N N N N N N N N N N

NETNAME Y N N N N N N N N N N N N N N N N N N N N N N N

REASON Y N N N N N N N N N N N N N N N N N N N N N N N




Table 344. INQUIRE UOWDSNFAIL CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CAUSE option

CACHE Y N N N N N N N N N N N N N N N N N N N N N N N



RLSSERVER Y N N N N N N N N N N N N N N N N N N N N N N N

UNDEFINED Y N N N N N N N N N N N N N N N N N N N N N N N

REASON option

BACKUPNONBWO Y N N N N N N N N N N N N N N N N N N N N N N N

COMMITFAIL Y N N N N N N N N N N N N N N N N N N N N N N N

DATASETFULL Y N N N N N N N N N N N N N N N N N N N N N N N

DEADLOCK Y N N N N N N N N N N N N N N N N N N N N N N N

DELEXITERROR Y N N N N N N N N N N N N N N N N N N N N N N N

FAILEDBKOUT Y N N N N N N N N N N N N N N N N N N N N N N N

INDEXRECFULL Y N N N N N N N N N N N N N N N N N N N N N N N

IOERROR Y N N N N N N N N N N N N N N N N N N N N N N N


OPENERROR Y N N N N N N N N N N N N N N N N N N N N N N N

RLSGONE Y N N N N N N N N N N N N N N N N N N N N N N N

RLSACCESS option



Recovery management 205

recovery management

INQUIRE UOWENQ

Table 345. INQUIRE UOWENQ option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENQFAILS Y N N N N N N N N N N N N N N N N N N N N N N N


QUALIFIER Y N N N N N N N N N N N N N N N N N N N N N N N

QUALLEN Y N N N N N N N N N N N N N N N N N N N N N N N

RELATION Y N N N N N N N N N N N N N N N N N N N N N N N

RESLEN Y N N N N N N N N N N N N N N N N N N N N N N N

RESOURCE Y N N N N N N N N N N N N N N N N N N N N N N N

STATE Y N N N N N N N N N N N N N N N N N N N N N N N

TASKID Y N N N N N N N N N N N N N N N N N N N N N N N




Table 346. INQUIRE UOWENQ CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

RELATION option

OWNER Y N N N N N N N N N N N N N N N N N N N N N N N

WAITER Y N N N N N N N N N N N N N N N N N N N N N N N

STATE option

ACTIVE Y N N N N N N N N N N N N N N N N N N N N N N N

RETAINED Y N N N N N N N N N N N N N N N N N N N N N N N

TYPE option


EXECENQ Y N N N N N N N N N N N N N N N N N N N N N N N

EXECENQADDR Y N N N N N N N N N N N N N N N N N N N N N N N

FILE Y N N N N N N N N N N N N N N N N N N N N N N N

TDQUEUE Y N N N N N N N N N N N N N N N N N N N N N N N

TSQUEUE Y N N N N N N N N N N N N N N N N N N N N N N N

206 API Structure

recovery management

INQUIRE UOWLINK

Table 347. INQUIRE UOWLINK option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

UOWLINK Y N N N N N N N N N N N N N N N N N N N N N N N

LINK Y N N N N N N N N N N N N N N N N N N N N N N N


PROTOCOL Y N N N N N N N N N N N N N N N N N N N N N N N

RESYNCSTATUS Y N N N N N N N N N N N N N N N N N N N N N N N

RMIQFY Y N N N N N N N N N N N N N N N N N N N N N N N

ROLE Y N N N N N N N N N N N N N N N N N N N N N N N




Table 348. INQUIRE UOWLINK CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PROTOCOL option

APPC Y N N N N N N N N N N N N N N N N N N N N N N N

IRC Y N N N N N N N N N N N N N N N N N N N N N N N

LU61 Y N N N N N N N N N N N N N N N N N N N N N N N


RESYNCSTATUS option

COLDSTART Y N N N N N N N N N N N N N N N N N N N N N N N


STARTING Y N N N N N N N N N N N N N N N N N N N N N N N

UNAVAILABLE Y N N N N N N N N N N N N N N N N N N N N N N N

UNCONNECTED Y N N N N N N N N N N N N N N N N N N N N N N N

WARMSTART Y N N N N N N N N N N N N N N N N N N N N N N N

ROLE option

COORDINATOR Y N N N N N N N N N N N N N N N N N N N N N N N

SUBORDINATE Y N N N N N N N N N N N N N N N N N N N N N N N

UNKNOWN Y N N N N N N N N N N N N N N N N N N N N N N N

TYPE option


RMI Y N N N N N N N N N N N N N N N N N N N N N N N

Recovery management 207

reco

very man

agem

ent

SE

TU

OW

LIN

K

Table 349. S

ET

UO

WLIN

Koption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

UO

WLIN

KY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

AC

TIO

NY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

Table 350. S

ET

UO

WLIN

KC

VD

Asupport

acrossC

ICS

platforms

CV

DA

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

AC

TIO

N option

DE

LET

EY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

208A

PI S

tructure

statistics

Statistics

INQUIRE STATISTICS

Table 351. INQUIRE STATISTICS option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENDOFDAY Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYHRS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYMINS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYSECS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVAL Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVALHRS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVALMINS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVALSECS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

NEXTTIME Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

NEXTTIMEHRS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

NEXTTIMEMINS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

NEXTTIMESECS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

RECORDING Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

Table 352. INQUIRE STATISTICS CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

RECORDING option

OFF Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ON Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N


statistics

SET STATISTICS

Table 353. SET STATISTICS option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ENDOFDAY Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYHRS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYMINS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

ENDOFDAYSECS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVAL Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

INTERVALHRS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVALMINS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

INTERVALSECS Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

RECORDING Y Y Y Y Y N N N N N N N N N N N Y Y Y Y Y N N N

RECORDNOW Y Y Y Y N N N N N N N N N N N N N N N N N N N N

RESETNOW Y Y Y Y N N N N N N N N N N N N N N N N N N N N

Table 354. SET STATISTICS CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

RECORDING option

OFF Y Y Y Y Y N N N N N N N N N N N 1 1 1 1 1 N N N

ON Y Y Y Y Y N N N N N N N N N N N 1 1 1 1 1 N N N

Notes:


210 API Structure

storage

Storage Control

INQUIRE STORAGE

Table 355. INQUIRE STORAGE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ADDRESS Y Y N N N N N N N N N N N N N N N N N N N N N N

ELEMENT Y Y N N N N N N N N N N N N N N N N N N N N N N

ELEMENTLIST Y Y N N N N N N N N N N N N N N N N N N N N N N

FLENGTH Y Y N N N N N N N N N N N N N N N N N N N N N N

LENGTHLIST Y Y N N N N N N N N N N N N N N N N N N N N N N

NUMELEMENTS Y Y N N N N N N N N N N N N N N N N N N N N N N

TASK Y Y N N N N N N N N N N N N N N N N N N N N N N


storage

212 API Structure

tasks

Tasks

INQUIRE TASK

Table 356 (Page 1 of 2). INQUIRE TASK option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TASK Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y

ATTACHTIME Y N N N N N N N N N N N N N N N N N N N N N N N

CMDSEC Y Y N N N N N N N N N N Y N N N N N N N N N N N

DTB 1 Y N N N N N N N N N N Y N N N N N N N N N N N

DTIMEOUT Y Y N N N N N N N N N N Y N N N N N N N N N N N

DUMPING Y Y N N N N N N N N N N Y N N N N N N N N N N N

FACILITY Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y

FACILITYTYPE Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y


INDOUBTMINS Y N N N N N N N N N N N N N N N N N N N N N N N

INDOUBTWAIT Y N N N N N N N N N N N N N N N N N N N N N N N

ISOLATEST Y Y N N N N N N N N N N Y N N N N N N N N N N N

PRIORITY Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N N N N

PROCESSID N N N N N N N N N N N N N N N N Y Y Y N N N N N

PROFILE Y Y N N N N N N N N N N Y N N N N N N N N N N N

PROGRAM Y Y N N N N N N N N N N Y N N N N N N N N N N N

PURGEABILITY Y Y N N N N N N N N N N Y N N N N N N N N N N N

RECUNITID 2 Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

REMOTENAME Y Y N N N N N N N N N N Y N N N N N N N N N N N

REMOTESYSTEM Y Y N N N N N N N N N N Y N N N N N N N N N N N

RESSEC Y Y N N N N N N N N N N Y N N N N N N N N N N N

ROUTING Y Y N N N N N N N N N N Y N N N N N N N N N N N

RTIMEOUT Y Y N N N N N N N N N N Y N N N N N N N N N N N

RUNAWAY Y Y N N N N N N N N N N Y N N N N N N N N N N N

RUNSTATUS Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

SCRNSIZE Y Y N N N N N N N N N N Y N N N N N N N N N N N

STARTCODE Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y Y Y Y

STORAGECLEAR Y Y N N N N N N N N N N Y N N N N N N N N N N N

SUSPENDTIME Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

SUSPENDTYPE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

SUSPENDVALUE Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

TASKDATAKEY Y Y N N N N N N N N N N Y N N N N N N N N N N N

TASKDATALOC Y Y N N N N N N N N N N Y N N N N N N N N N N N

TCLASS Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

TRACING Y Y N N N N N N N N N N Y N N N N N N N N N N N

TRANCLASS Y Y N N N N N N N N N N Y N N N N N N N N N N N

TRANPRIORITY Y Y N N N N N N N N N N Y N N N N N N N N N N N

TRANSACTION Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y


tasks

Table 356 (Page 2 of 2). INQUIRE TASK option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TRPROF Y Y N N N N N N N N N N Y N N N N N N N N N N N

TWASIZE Y Y N N N N N N N N N N Y N N N N N N N N N N N

USERID Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y Y Y Y


UOWSTATE N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

Table 357 (Page 1 of 2). INQUIRE TASK CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CMDSEC option

CMDSECNO Y Y N N N N N N N N N N Y N N N N N N N N N N N

CMDSECYES Y Y N N N N N N N N N N N N N N N N N N N N N N

DTB option

BACKOUT N Y N N N N N N N N N N Y N N N N N N N N N N N

COMMIT N Y N N N N N N N N N N N N N N N N N N N N N N

WAIT N Y N N N N N N N N N N N N N N N N N N N N N N

DUMPING option

NOTRANDUMP Y Y N N N N N N N N N N Y N N N N N N N N N N N

TRANDUMP Y Y N N N N N N N N N N Y N N N N N N N N N N N

FACILITYTYPE option

DEST Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y


TERM Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y

INDOUBT option



INDOUBTWAIT option



ISOLATEST option

ISOLATE Y Y N N N N N N N N N N Y N N N N N N N N N N N

NOISOLATE Y Y N N N N N N N N N N N N N N N N N N N N N N

PURGEABILITY option

NOTPURGEABLE Y Y N N N N N N N N N N Y N N N N N N N N N N N

PURGEABLE Y Y N N N N N N N N N N Y N N N N N N N N N N N

RESSEC option

RESSECNO Y Y N N N N N N N N N N Y N N N N N N N N N N N

RESSECYES Y Y N N N N N N N N N N N N N N N N N N N N N N

ROUTING option

DYNAMIC Y Y N N N N N N N N N N Y N N N N N N N N N N N

214 API Structure

tasks

Table 357 (Page 2 of 2). INQUIRE TASK CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

STATIC Y Y N N N N N N N N N N Y N N N N N N N N N N N

RUNSTATUS option

DISPATCHABLE Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

RUNNING Y Y Y Y Y N N N N N N N Y N N N Y Y Y Y Y N N N

SUSPENDED Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

SCRNSIZE option

ALTERNATE Y Y N N N N N N N N N N Y N N N N N N N N N N N

DEFAULT Y Y N N N N N N N N N N Y N N N N N N N N N N N

STORAGECLEAR option

CLEAR Y Y N N N N N N N N N N N N N N N N N N N N N N

NOCLEAR Y Y N N N N N N N N N N Y N N N N N N N N N N N

TASKDATAKEY option

CICSDATAKEY Y Y N N N N N N N N N N Y N N N N N N N N N N N

USERDATAKEY Y Y N N N N N N N N N N N N N N N N N N N N N N

TASKDATALOC option

ANY Y Y N N N N N N N N N N Y N N N N N N N N N N N

BELOW Y Y N N N N N N N N N N N N N N N N N N N N N N

TRACING option

SPECTRACE Y Y N N N N N N N N N N N N N N N N N N N N N N

SPRSTRACE Y Y N N N N N N N N N N N N N N N N N N N N N N

STANTRACE Y Y N N N N N N N N N N Y N N N N N N N N N N N

UOWSTATE option

INDOUBT N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

INFLIGHT N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

WAITFORGET N N N N N N N N N N N N N N N N Y Y Y Y Y N N N

Notes:

1. Replaced by INDOUBT and INDOUBTWAIT. Supported for compatibility but will return onlyNOTSUPPORTED.

2. Supported only as a synonym for UOW.

Tasks 215

tasks

SET TASK

Table 358. SET TASK option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


PRIORITY Y Y Y Y Y N N N N N N N Y Y Y Y N N N N N N N N

PURGETYPE Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y Y Y Y

Table 359. SET TASK CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

PURGETYPE option

FORCEPURGE Y Y Y Y Y N N N Y N N N Y Y Y Y 1 1 1 1 1 N N N

PURGE Y Y Y Y Y N N N Y N N N Y Y Y Y 1 1 1 1 1 Y Y Y

Notes:


INQUIRE TASK LIST

Table 360. INQUIRE TASK LIST option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DISPATCHABLE Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

LISTSIZE Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y N N N

RUNNING Y Y Y Y Y N N N N N N N Y N N N Y Y Y Y Y N N N

SET Y Y Y Y Y N N N Y N N N Y Y Y Y Y Y Y Y Y N N N

SETTRANSID Y Y Y Y N N N N Y N N N Y N N N Y Y Y Y Y N N N

SUSPENDED Y Y Y Y Y N N N Y N N N Y N N N Y Y Y Y Y N N N

Note:

1. Suspended is ignored for Transaction Server for Windows NT.

216 API Structure

tasks

INQ

UIR

ET

CL

AS

S

Table 361. IN

QU

IRE

TC

LAS

Soption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

TC

LAS

SY

YY

YY

NN

NY

NN

NY

NN

NN

NN

NN

NN

N

CU

RR

EN

TY

YY

YY

NN

NY

NN

NY

NN

NN

NN

NN

NN

N

MA

XIM

UM

YY

YY

YN

NN

YN

NN

YN

NN

NN

NN

NN

NN

SE

TT

CL

AS

S

Table 362. S

ET

TC

LAS

Soption

supportacross

CIC

Splatform

s

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

TC

LAS

SY

YY

YY

NN

NY

NN

NY

NN

NN

NN

NN

NN

N

MA

XIM

UM

YY

YY

YN

NN

YN

NN

YN

NN

NN

NN

NN

NN

INQ

UIR

ET

RA

NC

LA

SS

Table 363. IN

QU

IRE

TR

AN

CLA

SS

optionsupport

acrossC

ICS

platforms

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

TR

AN

CLA

SS

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

AC

TIV

EY

YN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

MA

XA

CT

IVE

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

PU

RG

ET

HR

ES

HY

YN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

QU

EU

ED

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

Tasks

217

tasks

Table 364. IN

QU

IRE

TR

AN

CLA

SS

browse

optionsupport

acrossC

ICS

platforms

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

AT

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

SE

TT

RA

NC

LA

SS

Table 365. S

ET

TR

AN

CLA

SS

optionsupport

acrossC

ICS

platforms

Op

tion

TS 1.1 OS/390

ESA 4.1

ESA 3.3

ESA 3.2.1

ESA 3.1.1

MVS 2.1.2

MVS 2.1.1

OS/VS 1.7

VSE 2.3

VSE 2.2

VSE 2.1

DOS/VS 1.7

OS/2 V3

OS/2 2.0.1

OS/2 V2

OS/2 1.20

AIX 2.1.1

AIX 2.1

6000 1.2

6000 1.1.1

6000 1.1.0

400 3.1

400 2.3

400 2.2

TR

AN

CLA

SS

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

MA

XA

CT

IVE

YY

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

PU

RG

ET

HR

ES

HY

YN

NN

NN

NN

NN

NN

NN

NN

NN

NN

NN

N

218A

PI S

tructure

temporary storage

Temporary storage

INQUIRE TSQUEUE

Table 366. INQUIRE TSQUEUE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TSQUEUE Y Y Y N N N N N N N N N Y N N N N N N N N N N N

FLENGTH Y Y Y N N N N N N N N N Y N N N N N N N N N N N

LASTUSEDINT Y N N N N N N N N N N N N N N N N N N N N N N N

LOCATION Y Y Y N N N N N N N N N Y N N N N N N N N N N N

MAXITEMLEN Y Y Y N N N N N N N N N Y N N N N N N N N N N N

MINITEMLEN Y Y Y N N N N N N N N N Y N N N N N N N N N N N

NUMITEMS Y Y Y N N N N N N N N N Y N N N N N N N N N N N



Table 367. INQUIRE TSQUEUE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

LOCATION option

AUXILIARY Y Y Y N N N N N N N N N Y N N N N N N N N N N N

MAIN Y Y Y N N N N N N N N N N N N N N N N N N N N N

Table 368. INQUIRE TSQUEUE browse option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AT Y Y Y N N N N N N N N N Y N N N N N N N N N N N


temporary storage

220 API Structure

transactions

Transactions

INQUIRE TRANSACTION

Table 369. INQUIRE TRANSACTION option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


CMDSEC Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

DTB 1 Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

DTIMEOUT Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

DUMPING Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y


INDOUBTMINS Y N N N N N N N N N N N N N N N N N N N N N N N


ISOLATEST Y Y N N N N N N N N N N Y N N N N N N N N N N N

PRIORITY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

PROFILE Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

PROGRAM Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

PURGEABILITY Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

REMOTENAME Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

REMOTESYSTEM Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

RESSEC Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

ROUTING Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

RTIMEOUT Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

RUNAWAY Y Y N N N N N N N N N N Y N N N N N N N N N N N

RUNAWAYTYPE Y Y N N N N N N N N N N Y N N N N N N N N N N N

SCRNSIZE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SHUTDOWN Y Y N N N N N N N N N N Y N N N N N N N N N N N


STORAGECLEAR Y Y N N N N N N N N N N Y N N N N N N N N N N N

TASKDATAKEY Y Y Y N N N N N N N N N Y N N N N N N N N N N N

TASKDATALOC Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

TCLASS Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N


TRANCLASS Y Y N N N N N N N N N N Y N N N N N N N N N N N

TRPROF Y Y Y Y N N N N Y N N N Y N N N N N N N N N N N

TWASIZE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y


transactions

Table 370 (Page 1 of 2). INQUIRE TRANSACTION CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CMDSEC option

CMDSECEXT N N N Y Y N N N N N N N N N N N N N N N N N N N

CMDSECNO Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

CMDSECYES Y Y Y N Y N N N N N N N N N N N N N N N N N N N

DTB option

BACKOUT N Y Y Y Y N Y N Y N N N Y N N N N N N N N N N N

COMMIT N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

NOBACKOUT N Y Y Y Y N N N Y N N N N N N N N N N N N N N N

WAIT Y Y Y Y Y N N N Y N N N N N N N N N N N N N N N

DUMPING option

NOTRANDUMP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

TRANDUMP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

ISOLATEST option

ISOLATE Y Y N N N N N N N N N N Y N N N N N N N N N N N

INDOUBT option



INDOUBTWAIT option



ISOLATEST option

NOISOLATE Y Y N N N N N N N N N N N N N N N N N N N N N N

PURGEABILITY option

NOTPURGEABLE Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

PURGEABLE Y Y Y Y Y N N N Y N N N Y Y Y Y N N N N N Y Y Y

RESSEC option

RESSECEXT N N N Y Y N N N Y N N N N N N N N N N N N N N N

RESSECNO Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

RESSECYES Y Y Y N Y N N N Y N N N N N N N N N N N N N N N

ROUTING option

DYNAMIC Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

STATIC Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

RUNAWAYTYPE option

SYSTEM Y Y N N N N N N N N N N Y N N N N N N N N N N N

USER Y Y N N N N N N N N N N N N N N N N N N N N N N

SCRNSIZE option

ALTERNATE Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

DEFAULT Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

SHUTDOWN option

SHUTDISABLED Y Y N N N N N N N N N N Y N N N N N N N N N N N

SHUTENABLED Y Y N N N N N N N N N N N N N N N N N N N N N N

STATUS option



STORAGECLEAR option

222 API Structure

transactions

Table 370 (Page 2 of 2). INQUIRE TRANSACTION CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

CLEAR Y Y N N N N N N N N N N N N N N N N N N N N N N

NOCLEAR Y Y N N N N N N N N N N Y N N N N N N N N N N N

TASKDATAKEY option

CICSDATAKEY Y Y Y N N N N N N N N N Y N N N N N N N N N N N

USERDATAKEY Y Y Y N N N N N N N N N N N N N N N N N N N N N

TASKDATALOC option

ANY Y Y Y Y N N N N N N N N Y N N N N N N N N N N N

BELOW Y Y Y Y N N N N N N N N N N N N N N N N N N N N

TRACING option

SPECTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

SPRSTRACE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


Table 371. INQUIRE TRANSACTION browse option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AT Y Y Y Y Y N N N N N N N Y N N N N N N N N N N N

Note:

1. Replaced by INDOUBT and INDOUBTWAIT; will return NOTSUPPORTED.

SET TRANSACTION

Table 372 (Page 1 of 2). SET TRANSACTION option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


DUMPING Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

PRIORITY Y Y Y Y Y Y Y Y Y Y Y Y Y N N N Y Y Y Y Y N N N

PURGEABILITY Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

RUNAWAY Y Y N N N N N N N N N N T N N N N N N N N N N N

RUNAWAYTYPE Y Y N N N N N N N N N N T N N N N N N N N N N N

SHUTDOWN Y Y N N N N N N N N N N T N N N N N N N N N N N

Transactions 223

transactions

Table 372 (Page 2 of 2). SET TRANSACTION option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2


TCLASS Y Y Y Y Y N N N Y N N N Y N N N N N N N N N N N

TRACING Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

TRANCLASS Y Y N N N N N N N N N N T N N N N N N N N N N N

Table 373. SET TRANSACTION CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

DUMPING option

NOTRANDUMP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

TRANDUMP Y Y Y Y Y N N N Y N N N Y N N N N N N N N Y Y Y

PURGEABILITY option

NOTPURGEABLE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

PURGEABLE Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

RUNAWAYTYPE option

SYSTEM Y Y N N N N N N N N N N Y N N N N N N N N N N N

USER Y Y N N N N N N N N N N T N N N N N N N N N N N

SHUTDOWN option

SHUTDISABLED Y Y N N N N N N N N N N Y N N N N N N N N N N N

SHUTENABLED Y Y N N N N N N N N N N T N N N N N N N N N N N

STATUS option

DISABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

ENABLED Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 1 1 1 1 1 Y Y Y

TRACING option

SPECTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N

SPRSTRACE Y Y Y Y Y N N N N N N N T N N N N N N N N N N N


Notes:


224 API Structure

transient data

Transient data

INQUIRE TDQUEUE

Table 374. INQUIRE TDQUEUE option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TDQUEUE Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATIFACILITY Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

ATITERMID Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATITRANID Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATIUSERID Y Y N N N N N N N N N N Y N N N N N N N N N N N

BLOCKFORMAT Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

BLOCKSIZE Y N N N N N N N N N N N N N N N N N N N N N N N

DATABUFFERS Y N N N N N N N N N N N N N N N N N N N N N N N

DDNAME Y N N N N N N N N N N N N N N N N N N N N N N N

DISPOSITION Y N N N N N N N N N N N N N N N N N N N N N N N

DSNAME Y N N N N N N N N N N N N N N N N N N N N N N N

EMPTYSTATUS Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

ENABLESTATUS Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ERROROPTION Y N N N N N N N N N N N N N N N N N N N N N N N

INDIRECTNAME Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y



IOTYPE Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

NUMITEMS Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

OPENSTATUS Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

PRINTCONTROL Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

RECORDFORMAT Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

RECORDLENGTH Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

RECOVSTATUS Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

REMOTENAME Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

REMOTESYSTEM Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

REWIND Y N N N N N N N N N N N N N N N N N N N N N N N

SYSOUTCLASS Y N N N N N N N N N N N N N N N N N N N N N N N

TRIGGERLEVEL Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

TYPE Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y


transient data

Table 375 (Page 1 of 2). INQUIRE TDQUEUE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ATIFACILITY option

NOTERMINAL Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

TERMINAL Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

NOTAPPLIC Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

BLOCKFORMAT option

BLOCKED Y Y Y Y Y N N N Y Y Y N N N N N N N N N N N N N

UNBLOCKED Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

DISPOSITION option

MOD Y N N N N N N N N N N N N N N N N N N N N N N N


OLD Y N N N N N N N N N N N N N N N N N N N N N N N

SHR Y N N N N N N N N N N N N N N N N N N N N N N N

EMPTYSTATUS option

EMPTY Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

FULL Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N Y Y Y

NOTEMPTY Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y


ENABLESTATUS option

DISABLED Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

DISABLING Y N N N N N N N N N N N N N N N N N N N N N N N

ENABLED Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

NOTAPPLIC Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ERROROPTION option

IGNORERR Y N N N N N N N N N N N N N N N N N N N N N N N

SKIP Y N N N N N N N N N N N N N N N N N N N N N N N

INDOUBT option

QUEUE Y N N N N N N N N N N N N N N N N N N N N N N N

REJECT Y N N N N N N N N N N N N N N N N N N N N N N N

INDOUBTWAIT option



IOTYPE option

INPUT Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

OUTPUT Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

READBACK Y Y Y Y Y N N N Y Y Y N N N N N N N N N N Y Y Y


OPENSTATUS option

CLOSED Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

CLOSING Y Y Y Y Y N N N N N N N N N N N N N N N N Y Y Y

OPEN Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

OPENING Y Y Y Y Y N N N N N N N N N N N N N N N N Y Y Y

SWITCHING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

PRINTCONTROL option

226 API Structure

transient data

Table 375 (Page 2 of 2). INQUIRE TDQUEUE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ASACTL Y Y Y Y Y N N N Y Y Y N N N N N N N N N N N N N

MCHCTL Y Y Y Y Y N N N Y Y Y N N N N N N N N N N N N N

NOCTL Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

NOTAPPLIC Y Y Y Y Y N N N Y Y Y N Y N N N N N N N N N N N

RECORDFORMAT option

FIXED Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

UNDEFINED 1 1 1 1 1 N N N 1 1 1 N N N N N N N N N N N N N

VARIABLE Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y


RECOVSTATUS option

LOGICAL Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

NOTRECOVABLE Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

PHYSICAL Y Y Y Y Y N N N Y Y Y N N N N N Y Y Y Y Y N N N


REWIND option

LEAVE Y N N N N N N N N N N N N N N N N N N N N N N N

REREAD Y N N N N N N N N N N N N N N N N N N N N N N N

TYPE option

EXTRA Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

INDIRECT Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

INTRA Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

REMOTE Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

Note:

1. This CVDA is recorded for completeness. Extrapartition queues can not be defined withRECORDFORMAT(UNDEFINED).

Transient data 227

transient data

SET TDQUEUE

Table 376. SET TDQUEUE option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

TDQUEUE Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATIFACILITY Y Y Y Y Y N N N Y Y Y N Y N N N Y Y Y Y Y Y Y Y

ATITERMID Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATITRANID Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

ATIUSERID Y Y N N N N N N N N N N T N N N N N N N N N N N

ENABLESTATUS Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

OPENSTATUS Y Y Y Y Y N N N N N N N Y Y Y Y Y Y Y Y Y Y Y Y

TRIGGERLEVEL Y Y Y Y Y N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y

Table 377. SET TDQUEUE CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ATIFACILITY option

NOTERMINAL Y Y Y Y Y N N N Y Y Y N Y N N N 1 1 1 1 1 Y Y Y

TERMINAL Y Y Y Y Y N N N Y Y Y N Y N N N 1 1 1 1 1 Y Y Y

ENABLESTATUS option

DISABLED Y Y Y Y Y N N N Y Y Y N Y Y Y Y 1 1 1 1 1 Y Y Y

ENABLED Y Y Y Y Y N N N Y Y Y N Y Y Y Y 1 1 1 1 1 Y Y Y

OPENSTATUS option

CLOSED Y Y Y Y Y N N N N N N N Y Y Y Y 1 1 1 1 1 Y Y Y

OPEN Y Y Y Y Y N N N N N N N Y Y Y Y 1 1 1 1 1 Y Y Y

Notes:


228 API Structure

volumes

Volumes

INQUIRE VOLUME

Table 378. INQUIRE VOLUME option support across CICS platforms

Option

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

VOLUME Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

AVAILSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

DATE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

EMPTYSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

JOURNALNUM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

LONGDATE Y Y N N N N N N N N N N N N N N N N N N N N N N

OPENSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

PART Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

TIME Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 379. INQUIRE VOLUME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

AVAILSTATUS option

FCLOSE Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FINPUT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FOPEN Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

FOUTPUT Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOWRITE Y Y Y Y N N N N N N N N N N N N N N N N N N N N

OK Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

READONLY 1 1 1 1 Y N N N N N N N N N N N N N N N N N N N

EMPTYSTATUS option

EMPTY Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

NOTEMPTY Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

OPENSTATUS option

CLOSED Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

OPEN Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

OPENING Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Note: Replaced by the NOWRITE CVDA. The READONLY CVDA has the same numeric value as theNOWRITE CVDA. However the CVDA is not diagnosed as no longer supported.


volumes

SET VOLUME

Table 380. SET VOLUME option support across CICS platforms

OptionT

S 1

.1 O

S/3

90

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

VOLUME Y Y Y Y Y N N N N N N N N N N N N N N N N N N N


AVAILSTATUS Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

JOURNALNUM Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

Table 381. SET VOLUME CVDA support across CICS platforms

CVDA

TS

1.1

OS

/390

ES

A 4

.1

ES

A 3

.3

ES

A 3

.2.1

ES

A 3

.1.1

MV

S 2

.1.2

MV

S 2

.1.1

OS

/VS

1.7

VS

E 2

.3

VS

E 2

.2

VS

E 2

.1

DO

S/V

S 1

.7

OS

/2 V

3

OS

/2 2

.0.1

OS

/2 V

2

OS

/2 1

.20

AIX

2.1

.1

AIX

2.1

6000

1.2

6000

1.1

.1

6000

1.1

.0

400

3.1

400

2.3

400

2.2

ACTION option



AVAILSTATUS option

NOWRITE Y Y Y Y N N N N N N N N N N N N N N N N N N N N

OK Y Y Y Y Y N N N N N N N N N N N N N N N N N N N

READONLY 1 1 1 1 Y N N N N N N N N N N N N N N N N N N N

Note:

1. Replaced by the NOWRITE option.

Note that the READONLY CVDA has the same numeric value as the NOWRITE CVDA. However theCVDA is not diagnosed as no longer supported.

230 API Structure

External interfaces


232 API Structure

epi

External Presentation Interface (EPI)

The External Presentation Interface (EPI) is an application programming interface that allows a non-CICSapplication program to appear to a CICS system as one or more standard 3270 terminals. The non-CICSapplication may start CICS transactions and send standard 3270 data streams to those transactions. Itmay also receive standard 3270 data streams in response.

EPI Product Support

Table 382. EPI Client/Server support matrix.

Server Client Protocol

| CICS TS for OS/390 V1.1| CICS/ESA V4.13

| OS/2, Windows, WindowsNT| Macintosh, Windows95| APPC

| CICS TS for OS/390 V1.1| CICS/ESA V4.13

| DOS| APPC1

CICS/400 V3.1 OS/2, Windows, WindowsNTDOS, Macintosh, Windows95

APPC

| CICS for AIX V2.1.1| CICS for AIX V2.1| CICS/6000 V1.2

| OS/2, Windows, SUN, WindowsNT| DOS, Macintosh, Windows95| TCP/IP

| CICS for AIX V2.1.1| CICS for AIX V2.1| OS/2, WindowsNT, Macintosh| DOS, Windows, Windows95| APPC

CICS for OS/2 V3CICS for OS/2 V2.0.1 multi-userCICS for OS/2 V2 multi-user

OS/2, Windows, WindowsNTDOS, Windows95

NetBIOSTCP/IP2

CICS for OS/2 V3CICS for OS/2 V2.0.1 multi-userCICS for OS/2 V2 multi-user

Macintosh TCP/IP2

CICS for OS/2 V3 OS/2, Windows, WindowsNTDOS, Windows95

APPC

Notes:

1. Only via NetWare for SAA in a gateway server2. CICS for OS/2 must be V2.0.1 or latest service level of V2.03. Requires the CICS/ESA server support for the CICS Clients, shipped as PTFs UN90142 and

UN90143.


epi

EPI Function Calls

Table 383 (Page 1 of 2). EPI standard definition

Function Parameters Return Codes

CICS_EpiInitialize VersionhWnd1

Msgid1

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_IS_INITCICS_EPI_ERR_VERSIONCICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EpiTerminate CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EpiListSystems NameSpaceSystemsList

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_MORE_SYSTEMSCICS_EPI_ERR_NO_SYSTEMSCICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EPI_ERR_NULL_PARM2

CICS_EpiAddTerminal NameSpaceSystemNetNameDevTypeNotifyFnDetailsTermIndex

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_MAX_TERMSCICS_EPI_ERR_SYSTEMCICS_EPI_NORMALCICS_EPI_ERR_SECURITY2


CICS_EPI_ERR_IN_CALLBACK2

CICS_EpiDelTerminal TermIndex CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_TRAN_ACTIVECICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EpiStartTran TermIndexTransIdDataSize

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_ATI_ACTIVECICS_EPI_ERR_TTI_ACTIVECICS_EPI_ERR_NO_DATACICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

234 API Structure

epi

Table 383 (Page 2 of 2). EPI standard definition


CICS_EpiReply TermIndexDataSize

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_NO_CONVERSECICS_EPI_ERR_NO_DATACICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EpiATIState TermIndexATIState

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_ATI_STATECICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2

CICS_EpiGetEvent TermIndexWaitEvent

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_MORE_DATACICS_EPI_ERR_MORE_EVENTSCICS_EPI_ERR_NO_EVENTCICS_EPI_ERR_WAITCICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2


CICS_EpiGetSysError TermIndexSysErr

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_NORMALCICS_EPI_ERR_IN_CALLBACK2


CICS_EpiSenseCode TermIndexSenseCode

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_ERR_SENSE_CODECICS_EPI_NORMALCICS_EPI_ERR_NULL_PARM2


CICS_EpiInquireSystem2 TermIndexSystem

CICS_EPI_ERR_FAILEDCICS_EPI_ERR_NOT_INITCICS_EPI_ERR_BAD_INDEXCICS_EPI_NORMALCICS_EPI_ERR_NULL_PARM2


Notes:

1. These parameters are only required for Microsoft Windows.2. Added in Version 101.

External Presentation Interface (EPI) 235

epi

Table 384. Product Differences

CICS OS/2 V2 The CICS_EpiSenseCode function is not supported.

CICS OS/2 V2CICS OS/2V2.01

CICS_EpiListSystems returns a maximum of one candidate system if CICS isrunning.

The DevType parameter on CICS_EpiAddTerminal has a maximum lengthvalue of 4.

The Transid parameter on CICS_EpiStartTran is ignored. The transaction ID shouldbe incorporated in the data stream.

The NetName parameter on CICS_Epi_Add_Terminal is replaced by TermName.

CICS OS/2 V3 CICS_EpiListSystems returns a maximum of one candidate system if CICS isrunning.

The DevType parameter on CICS_EpiAddTerminal has a maximum lengthvalue of 4.

The NetName parameter on CICS_Epi_Add_Terminal is replaced by TermName.

CICS/6000V1.1

ATI requests are not supported.

CICS_EPI_ERR_NO_DATA is not returned on CICS_Epi_StartTran.

EPI Data Structures

Table 385 (Page 1 of 2). EPI Data Structures

Structure Fields/Values

CICS_EpiSystem_t SystemNameDescription

CICS_EpiDetails_t TermName3

NetNameNumlinesNumcolumnsMaxDataErrLastLineErrIntensifyErrColorErrHilightHilightColorPrinter

CICS_EpiEventData_t TermIndexEvent1

EndReason2

TransIdAbendCodeDataSize

236 API Structure

epi

Table 385 (Page 2 of 2). EPI Data Structures

Structure Fields/Values

CICS_EpiSysError_t CauseValueMsg

CICS_EpiEvent_t CICS_EPI_EVENT_SENDCICS_EPI_EVENT_CONVERSECICS_EPI_EVENT_END_TRANCICS_EPI_EVENT_START_ATICICS_EPI_EVENT_END_TERMCICS_EPI_EVENT_HELP

CICS_EpiEnd_t CICS_EPI_END_SIGNOFFCICS_EPI_END_SHUTDOWNCICS_EPI_END_OUTSERVICECICS_EPI_END_UNKNOWNCICS_EPI_END_FAILED

CICS_EpiATIState CICS_EPI_ATI_ONCICS_EPI_END_HOLDCICS_EPI_END_QUERY

CICS_EpiWait_t CICS_EPI_WAITCICS_EPI_NOWAIT

CICS_EpiSenseCode_t CICS_EPI_SENSE_OPCHECKCICS_EPI_SENSE_REJECT

Notes:

1. This field is defined by CICSEpiEvent_t.2. This field is defined by CICSEpiEnd_t.3. This field only occurs in OS/2, DOS, and Windows clients.

Table 386. Product Differences

CICS OS/2 V2 CICS_EpiDetails_t contains an additional field: TermName.

External Presentation Interface (EPI) 237

epi

238 API Structure

External Call Interface (ECI V0)

The ECI is an application programming interface that enables a non-CICS program to call a programrunning in a server CICS system and to pass and receive data by means of a COMMAREA. The call issimilar in function to a CICS Distributed Program Link (DPL) and the called CICS program must satisfy therules already defined for DPL.

ECI V0 Product Support

The ECI V0 external interface is supported only by the client/ server combinations defined in Table 387

Table 387. ECI V0 Client/Server support matrix.

Client

Server

CICS OS/2V1.2

CICS OS/2V2

CICS OS/2 V2 N Y

OS/2 Y1 Y

Windows N Y

DOS N Y

Note:

1. Client programs are restricted to the V1.20 ECI Subset.

ECI V0 External Call� Call 'FAAECI' USING ECI-PARMS RETURNING RESPONSE. (Cobol)

� Call 'FaaExternalCall' USING ECI_PARMS. (Cobol)

� Response = FaaExternalCall(ECI_PARMS); (C)

Table 388 (Page 1 of 4). ECI External Call

eci_call_type ECI_PARMS Return Codes

ECI_SYNC_CALLS eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_mode

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERROR




ECI_ASYNC_CALLS eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_message_ideci_message_qualifiereci_window_handle

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_NULL_WIN_HANDLEECI_ERR_NULL_MESSAGE_IDECI_ERR_THREAD_CREATE_ERROR

ECI_SYNC_PARALLELS eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_luw_token

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_LUW_TOKEN

ECI_ASYNC_PARALLELS eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_message_ideci_message_qualifiereci_window_handleeci_luw_token

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_NULL_WIN_HANDLEECI_ERR_NULL_MESSAGE_IDECI_ERR_THREAD_CREATE_ERRORECI_ERR_LUW_TOKEN

ECI_SYNCOD eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_luw_token�

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_INVALID_DATA_AREA

240 API Structure



ECI_ASYNCO eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_message_qualifiereci_luw_token�

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_REQUEST_TIMEOUTECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_DATA_AREA

ECI_ASYNC_NOTIFY_MSGOW eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_async_notify.window_handleeci_async_notify.win_fields.hwndeci_async_notify.win_fields.hinstanceeci_message_ideci_message_qualifiereci_luw_token

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_REQUEST_TIMEOUTECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_NULL_WIN_HANDLEECI_ERR_NULL_MESSAGE_IDECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_INVALID_DATA_AREA

ECI_ASYNC_NOTIFY_SEMO eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_async_notify.sem_handleeci_message_qualifiereci_luw_token�

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_REQUEST_TIMEOUTECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_NULL_SEM_HANDLEECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_INVALID_DATA_AREA

ECI_GET_REPLYOW eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_code

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_NO_CICSECI_ERR_TRANSACTION_ABENDECI_ERR_RESOURCE_SHORTAGEECI_ERR_SYSTEM_ERRORECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREA

External Call Interface (ECI V0) 241



ECI_GET_REPLY_WAITO eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_code

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_NO_CICSECI_ERR_TRANSACTION_ABENDECI_ERR_RESOURCE_SHORTAGEECI_ERR_SYSTEM_ERRORECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREA

ECI_STATE_SYNCOD eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_luw_token

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_REQUEST_TIMEOUTECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_LUW_TOKENECI_ERR_INVALID_DATA_AREAECI_ERR_UNKNOWN_SERVER

ECI_STATE_ASYNCO eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_luw_token

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_REQUEST_TIMEOUTECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_LUW_TOKENECI_ERR_INVALID_DATA_AREA

ECI_STATE_ASYNC_MSGOW eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_async_notify.window_handleeci_async_notify.win_fields.hwndeci_async_notify.win_fields.hinstanceeci_message_id�eci_message_qualifiereci_luw_token�

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_REQUEST_TIMEOUTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_NULL_WIN_HANDLEECI_ERR_NULL_MESSAGE_IDECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREA

ECI_STATE_ASYNC_SEMO eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_async_notify.sem_handleeci_message_id�eci_message_qualifiereci_luw_token�

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_REQUEST_TIMEOUTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_NULL_SEM_HANDLEECI_ERR_NULL_MESSAGE_IDECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREA

Notes:

� S - V1.20 ECI subset can be used only by OS/2 clients.� O - Call types can be used by OS/2 clients.� D - Call types can be used by DOS clients.� W - Call types can be used by Microsoft Windows clients.

242 API Structure

External Call Interface (ECI V1)

The ECI is an application programming interface that enables a non-CICS program to call a programrunning in a server CICS system and to pass and receive data by means of a COMMAREA. The call issimilar in function to a CICS Distributed Program Link (DPL) and the called CICS program must satisfy therules already defined for DPL.

The interface described here is the CICS Family ECI, the recommended API for maximum platform anddevice independence. ECI V1 also includes support for the ECI V0 API.

Parameters added in V1 are highlighted.

ECI V1 Product Support

Table 389. ECI V1 Client/Server support matrix.

Server Client Protocol

| CICS TS for OS/390 V1.1| CICS/ESA V4.1| OS/2, Windows, WindowsNT,| Macintosh, Windows95| APPC

| CICS TS for OS/390 V1.1| CICS/ESA V4.1| DOS| APPC1

CICS/ESA V3.3CICS/MVS V2.1.2CICS/VSE V2.3, V2.2

OS/2, Windows,WindowsNT,Windows95,Macintosh

APPC

CICS/ESA V3.3CICS/MVS V2.1.2CICS/VSE V2.3, V2.2

DOS APPC1

CICS/400 V3.1 OS/2, Windows, WindowsNT,DOS, Macintosh, Windows95

APPC

| CICS for AIX V2.1.1| CICS for AIX V2.1| CICS/6000 V1.2

| OS/2, SUN, Windows, WindowsNT| DOS, Macintosh, Windows95| TCP/IP

| CICS for AIX V2.1.1| CICS for AIX V2.1| OS/2, Windows, WindowsNT| DOS, Macintosh, Windows95| APPC

CICS for OS/2 V3CICS for OS/2 V2.0.1 multi-user

OS/2, Windows, WindowsNTDOS, Windows95

NetBIOSTCP/IP2

CICS for OS/2 V3CICS for OS/2 V2.0.1 multi-user

Macintosh TCP/IP2

CICS for OS/2 V3 OS/2, Windows, WindowsNTDOS, Windows95

APPC

Notes:

1. Only via NetWare for SAA in a gateway server2. CICS for OS/2 must be V2.0.1 or latest service level of V2.0


ECI V1 External Call

� For COBOL programs:

CALL '_CICS_ExternalCall'USING BY REFERENCE ECI-PARMS

RETURNING ECI-RETURN-CODE.

� For C programs;

Response = CICS_ExternalCall(&EciBlock);

� For PL/I programs;

Response = CICS_ExternalCall(EciBlock);



ECI_SYNC eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_luw_tokeneci_versioneci_system_nameeci_userid2eci_password2eci_tpn1

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_INVALID_DATA_AREAECI_ERR_ROLLEDBACKECI_ERR_UNKNOWN_SERVERECI_ERR_INVALID_VERSIONECI_ERR_CALL_FROM_CALLBACKECI_ERR_INVALID_TRANSID

ECI_ASYNC eci_call_typeeci_program_nameeci_userideci_passwordeci_transideci_abend_codeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_message_qualifiereci_luw_tokeneci_callbackeci_versioneci_system_nameeci_userid2eci_password2eci_tpn1

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_LUW_TOKENECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_ALREADY_ACTIVEECI_ERR_RESOURCE_SHORTAGEECI_ERR_NO_SESSIONSECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_DATA_AREAECI_ERR_ROLLEDBACKECI_ERR_UNKNOWN_SERVERECI_ERR_INVALID_VERSIONECI_ERR_CALL_FROM_CALLBACKECI_ERR_INVALID_TRANSID

244 API Structure



ECI_GET_REPLY eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_codeeci_version

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_SYSTEM_ERRORECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREAECI_ERR_INVALID_VERSIONECI_ERR_CALL_FROM_CALLBACK

ECI_GET_REPLY_WAIT eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_codeeci_version


ECI_GET_SPECIFIC_REPLY eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_codeeci_message_qualifiereci_version


ECI_GET_SPECIFIC_REPLY_WAIT eci_call_typeeci_commareaeci_commarea_lengtheci_sys_return_codeeci_message_qualifiereci_version


ECI_STATE_SYNC eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_versioneci_system_name

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREAECI_ERR_UNKNOWN_SERVERECI_ERR_INVALID_VERSIONECI_ERR_CALL_FROM_CALLBACK

External Call Interface (ECI V1) 245



ECI_STATE_ASYNC eci_call_typeeci_commareaeci_commarea_lengtheci_timeouteci_sys_return_codeeci_extend_modeeci_message_qualifiereci_versioneci_system_name

ECI_NO_ERRORECI_ERR_INVALID_DATA_LENGTHECI_ERR_INVALID_EXTEND_MODEECI_ERR_NO_CICSECI_ERR_CICS_DIEDECI_ERR_REQUEST_TIMEOUTECI_ERR_RESPONSE_TIMEOUTECI_ERR_TRANSACTION_ABENDECI_ERR_EXEC_NOT_RESIDENTECI_ERR_SYSTEM_ERRORECI_ERR_THREAD_CREATE_ERRORECI_ERR_INVALID_CALL_TYPEECI_ERR_INVALID_DATA_AREAECI_ERR_UNKNOWN_SERVERECI_ERR_INVALID_VERSIONECI_ERR_CALL_FROM_CALLBACK

Note:

1. Supported by Version 1A.

ECI V1 Function Calls

Table 391. ECI V1 standard definition


CICS_EciListSystems NameSpaceSystemsList

ECI_NO_ERRORECI_ERR_MORE_SYSTEMSECI_ERR_NO_SYSTEMSECI_ERR_NO_CICSECI_ERR_INVALID_DATA_LENGTHECI_ERR_CALL_FROM_CALLBACKECI_ERR_SYSTEM_ERROR

246 API Structure

exci

EXternal CICS Interface (EXCI)

The EXCI is an application programming interface that enables a non-CICS program (a client program)running in MVS to call a program (a server program) running in a CICS/ESA 4.1 (or later) region and topass and receive data by means of a communications area. The CICS program is invoked as if linked-toby another CICS program.

This programming interface allows a user to allocate and Open sessions (or pipes) to a CICS system andto pass distributed program link (DPL) requests over them.

Unless the CICS region is running in a sysplex under CICS Transaction Server for OS/390 (or later) andtherefore able to use cross-system MRO (XCF/MRO), the client program and the CICS server region (theregion where the server program runs or is defined) must be in the same MVS image.

EXCI—EXEC Interface

EXEC CICS LINK

Table 392. EXternal CICS Interface standard definition


LINK APPLIDCOMMAREADATALENGTHLENGTHPROGRAMRETCODESYNCONRETURNTRANSID

INVREQLENGERRLINKERRNOTAUTH

EXCI—Call Interface

CALL DFHXCIS

Table 393 (Page 1 of 2). EXCI Call Interface

CALL Type Parameters Return Codes

Initialise_User version_numberreturn_areauser_tokencall_typeuser_name

OKRETRYABLESYSTEM_ERRORUSER_ERRORWARNING

Allocate_Pipe version_numberreturn_areauser_tokencall_typepipe_tokenCICS_applidallocate_opts



exci

Table 393 (Page 2 of 2). EXCI Call Interface

CALL Type Parameters Return Codes

Open_Pipe version_numberreturn_areauser_tokencall_typepipe_token


DPL version_numberreturn_areauser_tokencall_typepipe_tokenpgmnamecommareacommarea_lendata_lentransiduowiduserid


Close_Pipe version_numberreturn_areauser_tokencall_typepipe_token


Deallocate_Pipe version_numberreturn_areauser_tokencall_typepipe_token


248 API Structure

eti

External Transaction Initiation (ETI)

The ETI is an application programming interface that enables a non-CICS program to initiate a transactionin a CICS system running on the same processor. The transaction is executed asynchronously in a waysimilar to EXEC CICS START.

ETI Product Support

The ETI external interface is available only on CICS OS/2 servers; it is not available on clients.

ETI External Call

Table 394. ECI External Call

Call Parameters Return Codes1

FAAETI2

FaaExternalTransETI_PARMS ETI_NO_ERROR

ETI_ERR_GIVE_SEGETI_ERR_OPEN_QUEUEETI_ERR_NO_CICSETI_ERR_ALLOC_SEGETI_ERR_FREE_SEGETI_ERR_WRITE_QUEUEETI_ERR_SEM_SETETI_ERR_BAD_USAGEETI_ERR_INVALID_USERETI_ERR_INVALID_HOSTETI_ERR_INVALID_TRANSIDETI_ERR_NO_TERMINALETI_ERR_FATAL_ERRORETI_ERR_PURGEDETI_ERR_RESOURCE_SHORTAGEETI_ERR_INVALID_TERMINALETI_ERR_UNKNOWN_ERROR

Notes:

1. Return Codes are returned immediately.2. The FAAETI call is supported in COBOL only.


ETI_PARMS

ETI_PARMS is a structured parameter block which must be passed on each call to CICS.

Table 395. ETI_PARMS parameter block

Parameter Block Parameters

ETI_PARMS eti_transideti_termideti_partner_lu_nameeti_userideti_passwordeti_usageeti_return

250 API Structure

Index

AABCODE option

ABEND 11ASSIGN 61

ABDUMP optionASSIGN 61

ABEND command 11options

ABCODE 11CANCEL 11NODUMP 11

AbendCode fieldCICS_EpiEventData_t 236

ABPROGRAM optionASSIGN 61

ABSTIME optionASKTIME 87FORMATTIME 88

ACCESSMETHOD optionINQUIRE CONNECTION 135INQUIRE DSNAME 153INQUIRE FILE 179, 180INQUIRE TERMINAL 141, 144

ACCOUNT optionENTER MONITOR 98

ACCUM optionSEND CONTROL 36SEND MAP 36SEND TEXT 37

ACEE optionADDRESS 59

ACQSTATUS optionINQUIRE CONNECTION 135, 136INQUIRE TERMINAL 141, 144SET CONNECTION 137, 138SET MODENAME 140SET TERMINAL 148, 149

ACQUIRED CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 144, 147SET CONNECTION 138SET MODENAME 140SET TERMINAL 149

ACQUIRING CVDAINQUIRE TERMINAL 144, 147

ACTION optionSET DSNAME 155SET JOURNALNAME 188SET SYSDUMPCODE 160SET TRANDUMPCODE 162SET UOWLINK 208

ACTION option (continued)SET VOLUME 230

ACTIVE CVDAINQUIRE SYSTEM 173, 174INQUIRE UOW 203INQUIRE UOWENQ 206

ACTIVE optionINQUIRE MODENAME 139INQUIRE TRANCLASS 217

ACTPARTN optionSEND CONTROL 32SEND MAP 32SEND TEXT 32

ADD CVDASET SYSDUMPCODE 160SET TRANDUMPCODE 162SET VOLUME 230

ADD optionINQUIRE FILE 179, 180SET FILE 183, 184

ADDABLE CVDAINQUIRE FILE 180SET FILE 184

ADDRESS commandoptions

ACEE 59COMMAREA 58CSA 58CWA 58EIB 58SET 60TCTUA 58TWA 58USING 60

ADDRESS optionINQUIRE STORAGE 211

addressed data sets (ESDS)base support for 71description of 68

ADVANCE CVDASET JOURNALNUM 190

AFFINITY optionSET CONNECTION 137, 138

AFTER optionINQUIRE REQID 201POST 90ROUTE 40START 6, 84

AGE optionINQUIRE UOW 203

AKP optionINQUIRE SYSTEM 171


AKP option (continued)SET SYSTEM 175

ALARM optionSEND CONTROL 29SEND MAP 30SEND TEXT 30SEND TEXT NOEDIT 31

ALL optionSEND PAGE 33

ALLCONN CVDAINQUIRE CONNECTION 136INQUIRE MODENAME 139INQUIRE TERMINAL 144

ALLOCATE commandconditions

CBIDERR 14INVREQ 14PARTNERIDERR 17SYSBUSY 14SYSIDERR 14

optionsNOQUEUE 14NOSUSPEND 14PARTNER 17PROFILE 14STATE 14SYSID 14

allocate_opts parameterAllocate_Pipe 247

Allocate_PipeDFHXCIS call 247parameters

allocate_opts 247call_type 247CICS_applid 247pipe_token 247return_area 247user_token 247version_number 247

ALLQUERY CVDAINQUIRE TERMINAL 146

ALTER optionQUERY SECURITY 23

ALTERNATE CVDAINQUIRE TASK 215INQUIRE TRANSACTION 222

ALTERNATE optionCONVERSE 119SEND 119SEND CONTROL 36SEND MAP 36SEND TEXT 36

ALTPAGEHT optionINQUIRE TERMINAL 141

ALTPAGEWD optionINQUIRE TERMINAL 141

ALTPRINTER optionINQUIRE TERMINAL 141SET TERMINAL 148

ALTPRTCOPY CVDAINQUIRE TERMINAL 144SET TERMINAL 149

ALTPRTCOPYST optionINQUIRE TERMINAL 141, 144SET TERMINAL 148, 149

ALTSCRNHT optionASSIGN 61INQUIRE TERMINAL 141

ALTSCRNWD optionASSIGN 61INQUIRE TERMINAL 141

ALTSUFFIX optionINQUIRE TERMINAL 141

AMAXTASKS optionINQUIRE SYSTEM 171SET SYSTEM 175

ANY CVDAINQUIRE PROGRAM 198INQUIRE TASK 215INQUIRE TRANSACTION 223

ANY optionGETMAIN 104

ANYKEY optionHANDLE AID 119

AP optionINQUIRE TRACETYPE 167SET TRACETYPE 168

APLKYBD CVDAINQUIRE TERMINAL 144

APLKYBD optionASSIGN 61

APLKYBDST optionINQUIRE TERMINAL 141, 144

APLTEXT CVDAINQUIRE TERMINAL 144

APLTEXT optionASSIGN 61

APLTEXTST optionINQUIRE TERMINAL 141, 144

APPC CVDAINQUIRE CONNECTION 136INQUIRE UOWLINK 207

APPCPARALLEL CVDAINQUIRE TERMINAL 147

APPCSINGLE CVDAINQUIRE TERMINAL 147

APPLICATION optionINQUIRE TRACETYPE 167SET TRACETYPE 168

APPLID optionASSIGN 61EXCI LINK 247

252 API Structure

APPLID option (continued)INQUIRE SYSTEM 171

ARCHSTATUS optionINQUIRE JOURNALNUM 189

ASACTL CVDAINQUIRE TDQUEUE 227

ASCII optionINQUIRE TERMINAL 142, 144

ASCII7 CVDAINQUIRE TERMINAL 144

ASCII8 CVDAINQUIRE TERMINAL 144

ASIS optionCONVERSE 116RECEIVE 116RECEIVE MAP 29RECEIVE PARTN 32

ASKTIME commandABSTIME option 87

ASRAINTRPT optionASSIGN 61

ASRAKEY optionASSIGN 61

ASRAPSW optionASSIGN 61

ASRAREGS optionASSIGN 61

ASRASPC optionASSIGN 61

ASRASTG optionASSIGN 61

ASSEMBLER CVDAINQUIRE PROGRAM 198

ASSIGN commandoptions

ABCODE 61ABDUMP 61ABPROGRAM 61ALTSCRNHT 61ALTSCRNWD 61APLKYBD 61APLTEXT 61APPLID 61ASRAINTRPT 61ASRAKEY 61ASRAPSW 61ASRAREGS 61ASRASPC 61ASRASTG 61BTRANS 61CMDSEC 61COLOR 61CWALENG 61DEFSCRNHT 61DEFSCRNWD 61DELIMITER 61DESTCOUNT 61

ASSIGN command (continued)options (continued)

DESTID 61DESTIDLENG 61DS3270 61DSSCS 61EWASUPP 61EXTDS 61FACILITY 61FCI 61GCHARS 61GCODES 61GMMI 61HILIGHT 61INITPARM 61INITPARMLEN 62INPARTN 62INVOKINGPROGRAM 62KATAKANA 62LANGINUSE 62LDCMNEM 62LDCNUM 62MAPCOLUMN 62MAPHEIGHT 62MAPLINE 62MAPWIDTH 62MSRCONTROL 62NATLANGINUSE 62NETNAME 62NEXTTRANSID 62NUMTAB 62OPCLASS 62OPERKEYS 62OPID 62OPSECURITY 62ORGABCODE 62OUTLINE 62PAGENUM 62PARTNPAGE 62PARTNS 62PARTNSET 62PRINSYSID 62PROGRAM 62PS 62QNAME 62RESSEC 62RESTART 62RETURNPROG 62SCRNHT 62SCRNWD 62SIGDATA 62SOSI 62STARTCODE 62STATIONID 62SYSID 62TASKPRIORITY 62TCTUALENG 62

Index 253

ASSIGN command (continued)options (continued)

TELLERID 62TERMCODE 62TERMPRIORITY 62TEXTKYBD 63TEXTPRINT 63TRANPRIORITY 63TWALENG 63UNATTEND 63USERID 63USERNAME 63USERPRIORITY 63VALIDATION 63

AT optionINQUIRE PROGRAM 199INQUIRE REQID 201INQUIRE TRANCLASS 218INQUIRE TRANSACTION 223INQUIRE TSQUEUE 219POST 90ROUTE 40START 6, 84

ATI CVDAINQUIRE TERMINAL 144SET TERMINAL 149

ATIFACILITY optionINQUIRE TDQUEUE 225, 226SET TDQUEUE 228

ATIState parameterCICS_EpiATIState 235

ATISTATUS optionINQUIRE TERMINAL 142, 144SET TERMINAL 148, 149

ATITERMID optionINQUIRE TDQUEUE 225SET TDQUEUE 228

ATITRANID optionINQUIRE TDQUEUE 225SET TDQUEUE 228

ATIUSERID optionINQUIRE TDQUEUE 225SET TDQUEUE 228

ATTACHTIME optionINQUIRE TASK 213

AUDALARM CVDAINQUIRE TERMINAL 144

AUDALARMST optionINQUIRE TERMINAL 142, 144

AUTINSTMODEL optionINQUIRE AUTINSTMODEL 129

AUTOACTIVE CVDAINQUIRE SYSTEM 173SET SYSTEM 176

AUTOARCH CVDAINQUIRE JOURNALNUM 189

AUTOCONN CVDAINQUIRE CONNECTION 136INQUIRE MODENAME 139INQUIRE TERMINAL 144

AUTOCONNECT optionINQUIRE CONNECTION 135, 136INQUIRE MODENAME 139INQUIRE TERMINAL 142, 144

AUTOINACTIVE CVDAINQUIRE SYSTEM 173

AUTOPAGE optionSEND PAGE 38

AUTOPAGEABLE CVDAINQUIRE TERMINAL 146SET TERMINAL 149

AUXILIARY CVDAINQUIRE TSQUEUE 219

AUXILIARY optionWRITEQ TS 112

AUXPAUSE CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

AUXSTART CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

AUXSTATUS optionINQUIRE TRACEDEST 163SET TRACEDEST 164

AUXSTOP CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

AVAILABILITY optionSET DSNAME 155

AVAILABLE CVDAINQUIRE CONNECTION 136SET DSNAME 155

AVAILABLE optionINQUIRE MODENAME 139SET MODENAME 140

AVAILSTATUS optionINQUIRE VOLUME 229SET VOLUME 230

BBACKOUT CVDA

INQUIRE TASK 214INQUIRE TRANSACTION 222INQUIRE UOW 203SET CONNECTION 138SET DSNAME 155SET UOW 204

BACKTRANS CVDAINQUIRE TERMINAL 144

BACKTRANSST optionINQUIRE TERMINAL 142, 144

254 API Structure

BACKUPNONBWO CVDAINQUIRE UOWDSNFAIL 205

BACKUPTYPE optionINQUIRE DSNAME 153

BASE CVDAINQUIRE DSNAME 154INQUIRE FILE 181

BASEDSNAME optionINQUIRE DSNAME 153INQUIRE FILE 179

BASENAME optionINQUIRE FILE 179SET FILE 183

BDAM CVDAINQUIRE DSNAME 153INQUIRE FILE 180

BDAM filessupport for 77

BELOW CVDAINQUIRE PROGRAM 198INQUIRE TASK 215INQUIRE TRANSACTION 223

BELOW optionGETMAIN 104

BF optionINQUIRE TRACETYPE 167SET TRACETYPE 168

BGAM CVDAINQUIRE TERMINAL 144

BKOUTSTATUS optionINQUIRE DSNAME 153SET DSNAME 155

BLK CVDAINQUIRE FILE 181

BLOCKED CVDAINQUIRE FILE 180INQUIRE TDQUEUE 226

BLOCKFORMAT optionINQUIRE FILE 179, 180INQUIRE TDQUEUE 225, 226

BLOCKKEYLEN optionINQUIRE FILE 179

BLOCKSIZE optionINQUIRE FILE 179INQUIRE TDQUEUE 225

BM optionINQUIRE TRACETYPE 167SET TRACETYPE 168

BROWSABLE CVDAINQUIRE FILE 180SET FILE 184

BROWSE optionINQUIRE FILE 179, 180SET FILE 183, 184

BSAM CVDAINQUIRE TERMINAL 144

BTAM CVDAINQUIRE TERMINAL 144

BTRANS optionASSIGN 61

BUFFER optionRECEIVE 116

BUSY CVDAINQUIRE TERMINAL 145

BUSY optionSET DSNAME 155SET FILE 183, 184

CC CVDA

INQUIRE PROGRAM 198CACHE CVDA

INQUIRE UOWDSNFAIL 205call_type parameter

Allocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Initialise_User 247Open_Pipe 248

CALLER optionDUMP SYSTEM 52

CALLERLENGTH optionDUMP SYSTEM 52

CANCEL commandconditions

INVREQ 5, 83, 89ISCINVREQ 5, 83, 89NOTAUTH 5, 83NOTFND 5, 83, 89SYSIDERR 5, 83, 89

optionsREQID 5, 83, 89SYSID 5, 83, 89TRANSID 5, 83, 89

CANCEL CVDASET CONNECTION 138SET TERMINAL 149

CANCEL optionABEND 11HANDLE ABEND 11

CANCELAID optionSET TERMINAL 148

CANCELLED CVDAINQUIRE SYSTEM 174

Cause fieldCICS_EpiSysError_t 237

CAUSE optionINQUIRE UOWDSNFAIL 205

CBIDERR conditionALLOCATE 14

Index 255

CDSASIZE optionINQUIRE SYSTEM 171

CEDF CVDAINQUIRE PROGRAM 197SET PROGRAM 199

CEDFSTATUS optionINQUIRE PROGRAM 197SET PROGRAM 199

CHANGE PASSWORD commandconditions

INVREQ 24NOTAUTH 24USERIDERR 24

optionsESMREASON 24ESMRESP 24NEWPASSWORD 24PASSWORD 24USERID 24

CHANGE TASK commandconditions

INVREQ 109options

PRIORITY 109CHANGETIME option

VERIFY PASSWORD 25CICS_applid parameter

Allocate_Pipe 247CICS_ECI call

return codesECI_ERR_ALREADY_ACTIVE 244ECI_ERR_CALL_FROM_CALLBACK 244, 245,

246ECI_ERR_CICS_DIED 244, 245, 246ECI_ERR_EXEC_NOT_RESIDENT 244ECI_ERR_INVALID_CALL_TYPE 244, 245, 246ECI_ERR_INVALID_DATA_AREA 244, 245, 246ECI_ERR_INVALID_DATA_LENGTH 244, 245,

246ECI_ERR_INVALID_EXTEND_MODE 244, 245,

246ECI_ERR_INVALID_TRANSID 244ECI_ERR_INVALID_VERSION 244, 245, 246ECI_ERR_LUW_TOKEN 244ECI_ERR_NO_CICS 244, 245, 246ECI_ERR_NO_SESSIONS 244ECI_ERR_REQUEST_TIMEOUT 244, 245, 246ECI_ERR_RESOURCE_SHORTAGE 244ECI_ERR_RESPONSE_TIMEOUT 244, 245,

246ECI_ERR_ROLLEDBACK 244ECI_ERR_SYSTEM_ERROR 244, 245, 246ECI_ERR_THREAD_CREATE_ERROR 244,

245, 246ECI_ERR_TRANSACTION_ABEND 244ECI_ERR_UNKNOWN_SERVER 244, 245, 246ECI_NO_ERROR 244, 245, 246

CICS_EciListSystems functionparameters

List 246NameSpace 246Systems 246

return codesECI_ERR_CALL_FROM_CALLBACK 246ECI_ERR_INVALID_DATA_LENGTH 246ECI_ERR_MORE_SYSTEMS 246ECI_ERR_NO_CICS 246ECI_ERR_NO_SYSTEMS 246ECI_ERR_SYSTEM_ERROR 246ECI_NO_ERROR 246

CICS_EPI_ATI_ON valueCICS_EpiATIState_t 237

CICS_EPI_END_FAILED valueCICS_EpiEnd_t 237

CICS_EPI_END_HOLD valueCICS_EpiATIState_t 237

CICS_EPI_END_OUTSERVICE valueCICS_EpiEnd_t 237

CICS_EPI_END_QUERY valueCICS_EpiATIState_t 237

CICS_EPI_END_SHUTDOWN valueCICS_EpiEnd_t 237

CICS_EPI_END_SIGNOFF valueCICS_EpiEnd_t 237

CICS_EPI_END_UNKNOWN valueCICS_EpiEnd_t 237

CICS_EPI_ERR_ATI_ACTIVE return codeCICS_EpiStartTran 234

CICS_EPI_ERR_ATI_STATE return codeCICS_EpiATIState 235

CICS_EPI_ERR_BAD_INDEX return codeCICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInquireSystem 235CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234

CICS_EPI_ERR_FAILED return codeCICS_EpiAddTerminal 234CICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInitialize 234CICS_EpiInquireSystem 235CICS_EpiListSystems 234CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234CICS_EpiTerminate 234

256 API Structure

CICS_EPI_ERR_IN_CALLBACK return codeCICS_EpiAddTerminal 234CICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInitialize 234CICS_EpiInquireSystem 235CICS_EpiListSystems 234CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234CICS_EpiTerminate 234

CICS_EPI_ERR_IS_INIT return codeCICS_EpiInitialize 234

CICS_EPI_ERR_MAX_TERMS return codeCICS_EpiAddTerminal 234

CICS_EPI_ERR_MORE_DATA return codeCICS_EpiGetEvent 235

CICS_EPI_ERR_MORE_EVENTS return codeCICS_EpiGetEvent 235

CICS_EPI_ERR_MORE_SYSTEMS return codeCICS_EpiListSystems 234

CICS_EPI_ERR_NO_CONVERSE return codeCICS_EpiReply 235

CICS_EPI_ERR_NO_DATA return codeCICS_EpiReply 235CICS_EpiStartTran 234

CICS_EPI_ERR_NO_EVENT return codeCICS_EpiGetEvent 235

CICS_EPI_ERR_NO_SYSTEMS return codeCICS_EpiListSystems 234

CICS_EPI_ERR_NOT_INIT return codeCICS_EpiAddTerminal 234CICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInquireSystem 235CICS_EpiListSystems 234CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234CICS_EpiTerminate 234

CICS_EPI_ERR_NULL_PARM return codeCICS_EpiAddTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInquireSystem 235CICS_EpiListSystems 234CICS_EpiSenseCode 235

CICS_EPI_ERR_SECURITY return codeCICS_EpiAddTerminal 234

CICS_EPI_ERR_SENSE_CODE return codeCICS_EpiSenseCode 235

CICS_EPI_ERR_SYSTEM return codeCICS_EpiAddTerminal 234

CICS_EPI_ERR_TRAN_ACTIVE return codeCICS_EpiDelTerminal 234

CICS_EPI_ERR_TTI_ACTIVE return codeCICS_EpiStartTran 234

CICS_EPI_ERR_VERSION return codeCICS_EpiInitialize 234

CICS_EPI_ERR_WAIT return codeCICS_EpiGetEvent 235

CICS_EPI_EVENT_CONVERSE valueCICS_EpiEvent_t 237

CICS_EPI_EVENT_END_TERM valueCICS_EpiEvent_t 237

CICS_EPI_EVENT_END_TRAN valueCICS_EpiEvent_t 237

CICS_EPI_EVENT_HELP valueCICS_EpiEvent_t 237

CICS_EPI_EVENT_SEND valueCICS_EpiEvent_t 237

CICS_EPI_EVENT_START_ATI valueCICS_EpiEvent_t 237

CICS_EPI_NORMAL return codeCICS_EpiAddTerminal 234CICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInitialize 234CICS_EpiInquireSystem 235CICS_EpiListSystems 234CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234CICS_EpiTerminate 234

CICS_EPI_NOWAIT valueCICS_EpiWait_t 237

CICS_EPI_SENSE_OPCHECK valueCICS_EpISenseCode_t 237

CICS_EPI_SENSE_REJECT valueCICS_EpISenseCode_t 237

CICS_EPI_WAIT valueCICS_EpIWait_t 237

CICS_EpiAddTerminal functionparameters

details 234DevType 234NameSpace 234NetName 234NotifyFn 234system 234TermIndex 234

return codesCICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_MAX_TERMS 234CICS_EPI_ERR_NOT_INIT 234

Index 257

CICS_EpiAddTerminal function (continued)return codes (continued)

CICS_EPI_ERR_NULL_PARM 234CICS_EPI_ERR_SECURITY 234CICS_EPI_ERR_SYSTEM 234CICS_EPI_NORMAL 234

CICS_EpiATIState functionparameters

ATIState 235TermIndex 235

return codesCICS_EPI_ERR_ATI_STATE 235CICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_NORMAL 235

CICS_EpiATIState_t structureValues

CICS_EPI_ATI_ON 237CICS_EPI_END_HOLD 237CICS_EPI_END_QUERY 237

CICS_EpiDelTerminal functionparameters

TermIndex 234return codes

CICS_EPI_ERR_BAD_INDEX 234CICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_NOT_INIT 234CICS_EPI_ERR_TRAN_ACTIVE 234CICS_EPI_NORMAL 234

CICS_EpiDetails_t structurefields

Color 236ErrColor 236ErrHilight 236ErrIntensify 236ErrLastLine 236Hilight 236MaxData 236NetName 236Numcolumns 236Numlines 236Printer 236TermName 236

CICS_EpiEnd_t structureValues

CICS_EPI_END_FAILED 237CICS_EPI_END_OUTSERVICE 237CICS_EPI_END_SHUTDOWN 237CICS_EPI_END_SIGNOFF 237CICS_EPI_END_UNKNOWN 237

CICS_EpiEvent_t structureValues

CICS_EPI_EVENT_CONVERSE 237CICS_EPI_EVENT_END_TERM 237

CICS_EpiEvent_t structure (continued)Values (continued)

CICS_EPI_EVENT_END_TRAN 237CICS_EPI_EVENT_HELP 237CICS_EPI_EVENT_SEND 237CICS_EPI_EVENT_START_ATI 237

CICS_EpiEventData_t structurefields

AbendCode 236Data 236EndReason 236Event 236Size 236TermIndex 236Transid 236

CICS_EpiGetEvent functionparameters

Data 235TermIndex 235Wait 235

return codesCICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_MORE_DATA 235CICS_EPI_ERR_MORE_EVENTS 235CICS_EPI_ERR_NO_EVENT 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_ERR_NULL_PARM 235CICS_EPI_ERR_WAIT 235CICS_EPI_NORMAL 235

CICS_EpiGetSysError functionparameters

SysErr 235TermIndex 235

return codesCICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_ERR_NULL_PARM 235CICS_EPI_NORMAL 235

CICS_EpiInitialize functionparameters

hWnd 234Msgid 234systems 234version 234

return codesCICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_IS_INIT 234CICS_EPI_ERR_VERSION 234CICS_EPI_NORMAL 234

CICS_EpiInquireSystem functionparameters

system 235

258 API Structure

CICS_EpiInquireSystem function (continued)parameters (continued)

TermIndex 235return codes

CICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_ERR_NULL_PARM 235CICS_EPI_NORMAL 235

CICS_EpiListSystems functionparameters

list 234NameSpace 234

return codesCICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_MORE_SYSTEMS 234CICS_EPI_ERR_NO_SYSTEMS 234CICS_EPI_ERR_NOT_INIT 234CICS_EPI_ERR_NULL_PARM 234CICS_EPI_NORMAL 234

CICS_EpiReply functionparameters

Data 235Size 235TermIndex 235

return codesCICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_NO_CONVERSE 235CICS_EPI_ERR_NO_DATA 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_NORMAL 235

CICS_EpiSenseCode functionparameters

SenseCode 235TermIndex 235

return codesCICS_EPI_ERR_BAD_INDEX 235CICS_EPI_ERR_FAILED 235CICS_EPI_ERR_IN_CALLBACK 235CICS_EPI_ERR_NOT_INIT 235CICS_EPI_ERR_NULL_PARM 235CICS_EPI_ERR_SENSE_CODE 235CICS_EPI_NORMAL 235

CICS_EpiSenseCode_t structureValues

CICS_EPI_SENSE_OPCHECK 237CICS_EPI_SENSE_REJECT 237

CICS_EpiStartTran functionparameters

Data 234Size 234TermIndex 234TransId 234

CICS_EpiStartTran function (continued)return codes

CICS_EPI_ERR_ATI_ACTIVE 234CICS_EPI_ERR_BAD_INDEX 234CICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_NO_DATA 234CICS_EPI_ERR_NOT_INIT 234CICS_EPI_ERR_TTI_ACTIVE 234CICS_EPI_NORMAL 234

CICS_EpiSysError_t structurefields

Cause 237Msg 237Value 237

CICS_EpiSystem_t structurefields

Description 236SystemName 236

CICS_EpiTerminate functionreturn codes

CICS_EPI_ERR_FAILED 234CICS_EPI_ERR_IN_CALLBACK 234CICS_EPI_ERR_NOT_INIT 234CICS_EPI_NORMAL 234

CICS_EpiWait_t structureValues

CICS_EPI_NOWAIT 237CICS_EPI_WAIT 237

CICS_ExternalCall callparameter

ECI_PARMS 244EciBlock 244

return codesECI_ERR_ALREADY_ACTIVE 244ECI_ERR_CALL_FROM_CALLBACK 244, 245,

246ECI_ERR_CICS_DIED 244, 245, 246ECI_ERR_EXEC_NOT_RESIDENT 244ECI_ERR_INVALID_CALL_TYPE 244, 245, 246ECI_ERR_INVALID_DATA_AREA 244, 245, 246ECI_ERR_INVALID_DATA_LENGTH 244, 245,

246ECI_ERR_INVALID_EXTEND_MODE 244, 245,

246ECI_ERR_INVALID_TRANSID 244ECI_ERR_INVALID_VERSION 244, 245, 246ECI_ERR_LUW_TOKEN 244ECI_ERR_NO_CICS 244, 245, 246ECI_ERR_NO_SESSIONS 244ECI_ERR_REQUEST_TIMEOUT 244, 245, 246ECI_ERR_RESOURCE_SHORTAGE 244ECI_ERR_RESPONSE_TIMEOUT 244, 245,

246ECI_ERR_ROLLEDBACK 244ECI_ERR_SYSTEM_ERROR 244, 245, 246ECI_ERR_THREAD_CREATE_ERROR 244,

245, 246

Index 259

CICS_ExternalCall call (continued)return codes (continued)

ECI_ERR_TRANSACTION_ABEND 244ECI_ERR_UNKNOWN_SERVER 244, 245, 246ECI_NO_ERROR 244, 245, 246

CICSDATAKEY CVDAINQUIRE TASK 215INQUIRE TRANSACTION 223

CICSDATAKEY optionGETMAIN 104

CICSEXECKEY CVDAINQUIRE PROGRAM 198

CICSSECURITY CVDAINQUIRE SYSTEM 173

CICSSTATUS optionINQUIRE SYSTEM 171, 173

CICSSYS optionINQUIRE SYSTEM 171

CICSTABLE CVDAINQUIRE FILE 182SET FILE 184

CLEAR CVDAINQUIRE TASK 215INQUIRE TRANSACTION 223

CLEAR optionHANDLE AID 119

Close_PipeDFHXCIS call 248parameters

call_type 248pipe_token 248return_area 248user_token 248version_number 248

CLOSED CVDAINQUIRE DUMPDS 157INQUIRE FILE 181INQUIRE IRC 131INQUIRE JOURNALNUM 190INQUIRE TDQUEUE 226INQUIRE VOLUME 229INQUIRE VTAM 132SET DUMPDS 158SET FILE 184SET IRC 131SET JOURNALNUM 190SET MODENAME 140SET TDQUEUE 228SET VTAM 133

CLOSEFAILED CVDAINQUIRE VTAM 132

CLOSELEAVE CVDASET JOURNALNUM 190

CLOSEREQUEST CVDAINQUIRE FILE 181

CLOSING CVDAINQUIRE FILE 181INQUIRE IRC 131INQUIRE TDQUEUE 226INQUIRE VTAM 132

CLRPARTN optionHANDLE AID 119

CMDPROT CVDAINQUIRE SYSTEM 173

CMDPROTECT optionINQUIRE SYSTEM 171, 173

CMDSEC optionASSIGN 61INQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222

CMDSECEXT CVDAINQUIRE TRANSACTION 222

CMDSECNO CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

CMDSECYES CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

COBOL CVDAINQUIRE PROGRAM 197, 198

COBOLII CVDAINQUIRE PROGRAM 197

COBOLTYPE optionINQUIRE PROGRAM 197

COLD CVDAINQUIRE SYSTEM 173

COLDACQ CVDASET TERMINAL 149

COLDQUERY CVDAINQUIRE TERMINAL 146

COLDSTART CVDAINQUIRE SYSTEM 174INQUIRE UOWLINK 207

COLDSTATUS optionINQUIRE SYSTEM 171, 173

COLOR CVDAINQUIRE TERMINAL 144

Color fieldCICS_EpiDetails_t 236

COLOR optionASSIGN 61

COLORST optionINQUIRE TERMINAL 142, 144

COMMAREA optionADDRESS 58EXCI LINK 247LINK 99RETURN 100XCTL 100

commarea parameterDPL 248

260 API Structure

commarea_len parameterDPL 248

COMMIT CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222INQUIRE UOW 203SET CONNECTION 138SET DSNAME 155SET UOW 204

COMMITFAIL CVDAINQUIRE UOWDSNFAIL 205

COMPLETE optionDUMP 50DUMP TRANSACTION 50

CONFIRM optionSEND 15

CONNECT PROCESS commandconditions

INVREQ 14LENGERR 14, 16NOTALLOC 14PARTNERIDERR 17

optionsCONVID 14PARTNER 17PIPLENGTH 16PIPLIST 16PROCLENGTH 14PROCNAME 14STATE 14SYNCLEVEL 14

CONNECTED CVDAINQUIRE EXITPROGRAM 177

CONNECTION CVDAINQUIRE UOW 203INQUIRE UOWDSNFAIL 205INQUIRE UOWLINK 207

CONNECTION optionINQUIRE CONNECTION 135INQUIRE MODENAME 139SET CONNECTION 137SET MODENAME 140

CONNECTST optionINQUIRE EXITPROGRAM 177

CONNSTATUS optionINQUIRE CONNECTION 135, 136SET CONNECTION 137, 138

CONNTYPE optionINQUIRE CONNECTION 135, 136

CONSISTENT CVDAINQUIRE FILE 181SET FILE 184

CONSISTENT optionREAD 80READNEXT 80READPREV 80

CONSOLE CVDAINQUIRE TERMINAL 144

CONTROL optionQUERY SECURITY 23

CONTROLSHUT CVDAINQUIRE SYSTEM 174

CONVERSE commandadvanced program-to-program communication

(APPC) mapped 14conditions

EOC 14, 15INVREQ 14, 116LENGERR 14, 116NOTALLOC 14SIGNAL 14TERMERR 14, 116

optionsALTERNATE 119ASIS 116CONVID 14CTLCHAR 116DEFAULT 119DEFRESP 116ERASE 116FROM 14, 116FROMFLENGTH 14, 116FROMLENGTH 14, 116INTO 14, 116MAXFLENGTH 14, 116MAXLENGTH 14, 116NOTRUNCATE 14, 116SET 14, 116STATE 14STRFIELD 116TOFLENGTH 14, 116TOLENGTH 14, 116

terminal control (3270) 116CONVERSE CVDA

INQUIRE MONITOR 193SET MONITOR 194

CONVERSEST optionINQUIRE MONITOR 193SET MONITOR 194

CONVID optionCONNECT PROCESS 14CONVERSE 14EXTRACT ATTRIBUTES 14EXTRACT PROCESS 14FREE 14ISSUE ABEND 14ISSUE CONFIRMATION 14ISSUE ERROR 14ISSUE PREPARE 14ISSUE SIGNAL 15RECEIVE 15SEND 15

Index 261

CONVID option (continued)WAIT 15

COORDINATOR CVDAINQUIRE UOWLINK 207

COPY CVDAINQUIRE TERMINAL 145

COPY optionINQUIRE PROGRAM 197, 198SET PROGRAM 199, 200

COPYST optionINQUIRE TERMINAL 142, 144

CORRELID optionINQUIRE TERMINAL 142

CP optionINQUIRE TRACETYPE 167SET TRACETYPE 168

CPI optionINQUIRE TRACETYPE 167SET TRACETYPE 168

CREATE CVDAINQUIRE TERMINAL 145SET TERMINAL 149

CREATESESS optionINQUIRE TERMINAL 142, 145SET TERMINAL 148, 149

CSA optionADDRESS 58

CSCS optionINQUIRE SYSTEM 171SET SYSTEM 175

CTLCHAR optionCONVERSE 116ISSUE COPY 118SEND 116

CTLGALL CVDAINQUIRE SYSTEM 173SET SYSTEM 176

CTLGMODIFY CVDAINQUIRE SYSTEM 173SET SYSTEM 176

CTLGNONE CVDAINQUIRE SYSTEM 173SET SYSTEM 176

CURAUXDS optionINQUIRE TRACEDEST 163

CURRENT CVDAINQUIRE JOURNALNUM 189

CURRENT optionINQUIRE SYSDUMPCODE 158INQUIRE TCLASS 217INQUIRE TRANDUMPCODE 161SEND PAGE 33

CURRENTDDS optionINQUIRE DUMPDS 157

CURRENTVOL optionINQUIRE JOURNALNUM 189

CURREQS optionINQUIRE AUTOINSTALL 129

CURSOR optionSEND CONTROL 29SEND MAP 30SEND TEXT 30

CUSHION optionINQUIRE SYSTEM 171SET SYSTEM 175

CVDA 8CWA option

ADDRESS 58CWALENG option

ASSIGN 61

DDAE CVDA

INQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

DAEOPTION optionINQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

DAM filessupport for 77

Data fieldCICS_EpiEventData_t 236

DATA optionFREEMAIN 103

Data parameterCICS_EpiGetEvent 235CICS_EpiReply 235CICS_EpiStartTran 234

data_len parameterDPL 248

DATA1 optionMONITOR 97

DATA2 optionMONITOR 97

DATABUFFERS optionINQUIRE TDQUEUE 225

DATALENGTH optionEXCI LINK 247LINK 99

DATALOCATION optionINQUIRE PROGRAM 197, 198

DATAONLY optionSEND MAP 30

DATAPOINTER optionFREEMAIN 103

DATASET CVDAINQUIRE UOW 203INQUIRE UOWDSNFAIL 205INQUIRE UOWENQ 206

DATASETFULL CVDAINQUIRE UOWDSNFAIL 205

262 API Structure

DATASTREAM optionINQUIRE TERMINAL 142, 145

DATE optionFORMATTIME 88INQUIRE VOLUME 229

DATEFORM optionFORMATTIME 88INQUIRE SYSTEM 171

DATESEP optionFORMATTIME 88

DAYCOUNT optionFORMATTIME 88

DAYOFMONTH optionFORMATTIME 88

DAYOFWEEK optionFORMATTIME 88

DAYSLEFT optionVERIFY PASSWORD 25

DC optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DCT optionDUMP 50DUMP TRANSACTION 50

DD optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DDMMYY optionFORMATTIME 88

DDMMYYYY optionFORMATTIME 88

DDNAME optionINQUIRE TDQUEUE 225

DEADLOCK CVDAINQUIRE UOWDSNFAIL 205

Deallocate_Pipeparameters

pipe_token 248return_area 248user_token 248version_number 248

DEBKEY optionREAD 77STARTBR 78

DEBREC optionREAD 77STARTBR 78

DEC CVDAINQUIRE FILE 181

DEFAULT CVDAINQUIRE TASK 215INQUIRE TRANSACTION 222

DEFAULT optionCONVERSE 119SEND 119SEND CONTROL 36

DEFAULT option (continued)SEND MAP 36SEND TEXT 36

DEFPAGEHT optionINQUIRE TERMINAL 142

DEFPAGEWD optionINQUIRE TERMINAL 142

DEFRESP optionCONVERSE 116SEND 116

DEFSCRNHT optionASSIGN 61INQUIRE TERMINAL 142

DEFSCRNWD optionASSIGN 61INQUIRE TERMINAL 142

DELAY commandconditions

EXPIRED 90INVREQ 90

optionsFOR 90HOURS 90INTERVAL 90MINUTES 90REQID 90SECONDS 90TIME 90UNTIL 90

DELAY CVDAINQUIRE REQID 201

DELETABLE CVDAINQUIRE FILE 180SET FILE 184

DELETE commandaddressed file standard definition 71conditions

DISABLED 68, 71, 73DUPKEY 68FILENOTFOUND 68, 71, 73ILLOGIC 68, 73INVREQ 68, 71, 73, 80IOERR 68, 73ISCINVREQ 68, 71, 73LOCKED 80NOTAUTH 68, 71, 73NOTFND 68, 73NOTOPEN 68, 71, 73RECORDBUSY 80SYSIDERR 68, 71, 73

keyed file standard definition 68numbered file standard definition 73options

FILE 68, 71, 73GENERIC 68KEYLENGTH 68NOSUSPEND 80

Index 263

DELETE command (continued)options (continued)

NUMREC 68RBA 71, 79RIDFLD 68, 71, 73RRN 73SYSID 68, 71, 73TOKEN 80

DELETE CVDASET UOWLINK 208

DELETE optionINQUIRE FILE 179, 180SET FILE 183, 184

DELETEQ TD commandconditions

DISABLED 123INVREQ 123ISCINVREQ 123LOCKED 125NOTAUTH 123QIDERR 123SYSIDERR 123

optionsQUEUE 123SYSID 123

DELETEQ TS commandconditions

INVREQ 111ISCINVREQ 111LOCKED 113NOTAUTH 111QIDERR 111SYSIDERR 111

optionsQUEUE 111SYSID 111

DELEXITERROR CVDAINQUIRE UOWDSNFAIL 205

DELIMITER optionASSIGN 61

DEQ commandoptions

INVREQ 107LENGERR 107LENGTH 107LUW 107MAXLIFETIME 107RESOURCE 107TASK 107

DEREGERROR CVDAINQUIRE VTAM 132

DEREGISTERED CVDAINQUIRE VTAM 132

Description fieldCICS_EpiSystem_t 236

DEST CVDAINQUIRE TASK 214

DESTCOUNT optionASSIGN 61

DESTID optionASSIGN 61

DESTIDLENG optionASSIGN 61

details parameterCICS_EpiAddTerminal 234

DEVICE optionINQUIRE TERMINAL 142

DEVICEST optionINQUIRE TERMINAL 142, 145

DevType parameterCICS_EpiAddTerminal 234

DFHMDF optionsBMS map definition interface base 42device support tower 44

DFHMDI optionsBMS map definition interface base 42cumulative mapping tower 46cursor location tower 48device support tower 44programming language support tower 47

DFHMSD optionsBMS map definition interface base 42cursor location tower 48device support tower 43programming language support tower 47

DFHPDI optionsdevice support tower 45

DFHPSD optionsdevice support tower 45

DFHXCIScall type

Allocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Initialise_User 247Open_Pipe 248

DFHXCIS callreturn codes

OK 247, 248RETRYABLE 247, 248SYSTEM_ERROR 247, 248USER_ERROR 247, 248WARNING 247, 248

DFLTREMSYS optionINQUIRE SYSTEM 171SET SYSTEM 175

DFLTUSER optionINQUIRE SYSTEM 171

DI optionINQUIRE TRACETYPE 167

264 API Structure

DI option (continued)SET TRACETYPE 168

DIRMGR optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DISABLED conditionDELETE 68, 71, 73ENDBR 69, 71, 74, 77READ 69, 71, 74, 77READNEXT 69, 72, 74READPREV 69, 72, 74RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WRITE 71, 73, 76, 78

DISABLED CVDAINQUIRE AUTOINSTALL 129INQUIRE FILE 180INQUIRE JOURNALNAME 188INQUIRE PROGRAM 198INQUIRE TDQUEUE 226INQUIRE TRANSACTION 222SET FILE 184SET JOURNALNAME 188SET PROGRAM 200SET TDQUEUE 228SET TRANSACTION 224

DISABLING CVDAINQUIRE FILE 180INQUIRE TDQUEUE 226

DISCREQ CVDAINQUIRE TERMINAL 145SET TERMINAL 149

DISCREQST optionINQUIRE TERMINAL 142, 145SET TERMINAL 148, 149

DISK1 CVDAINQUIRE JOURNALNUM 189

DISK2 CVDAINQUIRE JOURNALNUM 189

DISK2PAUSE CVDAINQUIRE JOURNALNUM 190

DISKASTATUS optionINQUIRE JOURNALNUM 189

DISKBSTATUS optionINQUIRE JOURNALNUM 189

DISKXSTATUS optionINQUIRE JOURNALNUM 189

DISPATCHABLE CVDAINQUIRE TASK 215

DISPATCHABLE optionINQUIRE TASK LIST 216

DISPATCHER optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DISPOSITION optionINQUIRE FILE 179, 180INQUIRE TDQUEUE 225, 226SET FILE 183

DISPOSTION optionSET FILE 184

DM optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DOMAINMGR optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DPLDFHXCIS call 248parameters

call_type 248commarea 248commarea_len 248data_len 248pgmname 248pipe_token 248return_area 248transid 248uowid 248user_token 248userid 248version_number 248

DPLSUBSET CVDAINQUIRE PROGRAM 198SET PROGRAM 200

DS optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DS3270 CVDAINQUIRE TERMINAL 145

DS3270 optionASSIGN 61

DSALIMIT optionINQUIRE SYSTEM 171SET SYSTEM 175

DSASIZE optionINQUIRE SYSTEM 171

DSNAME optionINQUIRE DSNAME 153INQUIRE FILE 179INQUIRE TDQUEUE 225INQUIRE UOWDSNFAIL 205SET DSNAME 155SET FILE 183

DSSCS optionASSIGN 61

DTB optionINQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222

DTIMEOUT optionINQUIRE TASK 213

Index 265

DTIMEOUT option (continued)INQUIRE TRANSACTION 221

DTRPROGRAM optionINQUIRE SYSTEM 171SET SYSTEM 175

DU optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DUALCASE CVDAINQUIRE TERMINAL 145

DUALCASEST optionINQUIRE TERMINAL 142, 145

DUMMY CVDAINQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 188

DUMP commandoptions

COMPLETE 50DCT 50DUMPCODE 50FCT 50FLENGTH 50FROM 50LENGTH 50PCT 50PPT 50PROGRAM 50SIT 50STORAGE 50TABLES 50TASK 50TCT 50TERMINAL 50

DUMP optionINQUIRE TRACETYPE 167SET TRACETYPE 168

DUMP SYSTEM commandconditions

INVREQ 52IOERR 52NOSPACE 52NOSTG 52SUPPRESSED 52SYSBUSY 52

optionsCALLER 52CALLERLENGTH 52DUMPCODE 52DUMPID 52TITLE 52TITLELENGTH 52

DUMP TRANSACTION commandconditions

INVREQ 50IOERR 50NOSPACE 50NOSTG 50

DUMP TRANSACTION command (continued)conditions (continued)

NOTOPEN 50OPENERR 50SUPPRESSED 50

optionsCOMPLETE 50DCT 50DUMPCODE 50DUMPID 50FCT 50FLENGTH 50FROM 50LENGTH 50LENGTHLIST 50NUMSEGMENTS 50PCT 50PPT 50PROGRAM 50SEGMENTLIST 50SIT 50STORAGE 50TABLES 50TASK 50TCT 50TERMINAL 50TRT 50

DUMPCODE optionDUMP 50DUMP SYSTEM 52DUMP TRANSACTION 50

DUMPID optionDUMP SYSTEM 52DUMP TRANSACTION 50

DUMPING optionINQUIRE SYSTEM 171, 173INQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222SET SYSTEM 175, 176SET TRANSACTION 223, 224

DUMPSCOPE optionINQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

DUPKEY conditionDELETE 68READ 69READNEXT 69READPREV 69

DUPREC conditionREWRITE 70, 72, 75WRITE 71, 76, 78

DYNAMIC CVDAINQUIRE DSNAME 153INQUIRE TASK 214INQUIRE TRANSACTION 222

266 API Structure

EECADDR option

WAIT EVENT 90ECBLIST option

WAIT EXTERNAL 109WAITCICS 109

ECDSASIZE optionINQUIRE SYSTEM 171

ECI-PARMSparameters

eci_abend_code 239, 240, 241, 244eci_async_notify.sem_handle 241, 242eci_async_notify.win_fields.hinstance 241, 242eci_async_notify.win_fields.hwnd 241, 242eci_async_notify.window_handle 241, 242eci_callback 244eci_commarea 239, 240, 241, 242, 244, 245,

246eci_commarea_length 239, 240, 241, 242, 244,

245, 246eci_extend_mode 239, 240, 241, 242, 244, 245,

246eci_luw_token 240, 241, 242, 244eci_message_id 240, 241, 242eci_message_qualifier 240, 241, 242, 244, 245,

246eci_password 239, 240, 241, 244eci_password2 244eci_program_name 239, 240, 241, 242, 244,

245, 246eci_sys_return_code 239, 240, 241, 242, 244,

245, 246eci_system_name 244, 245, 246eci_timeout 239, 240, 241, 242, 244, 245, 246eci_tpn 244eci_transid 239, 240, 241, 244eci_userid 239, 240, 241, 244eci_userid2 244eci_version 244, 245, 246eci_window_handle 240system_name 244

eci_abend_code parameterECI-PARMS 239, 240, 241, 244

ECI_ASYNC valueeci_call_type 241

ECI_ASYNC_CALL valueeci_call_type 240, 244

ECI_ASYNC_NOTIFY_MSG valueeci_call_type 241

ECI_ASYNC_NOTIFY_SEM valueeci_call_type 241

eci_async_notify.sem_handle parameterECI-PARMS 241, 242

eci_async_notify.win_fields.hinstance parameterECI-PARMS 241, 242

eci_async_notify.win_fields.hwnd parameterECI-PARMS 241, 242

eci_async_notify.window_handle parameterECI-PARMS 241, 242

ECI_ASYNC_PARALLEL valueeci_call_type 240

eci_call_typevalues

ECI_ASYNC 241ECI_ASYNC_CALL 240, 244ECI_ASYNC_NOTIFY_MSG 241ECI_ASYNC_NOTIFY_SEM 241ECI_ASYNC_PARALLEL 240ECI_GET_REPLY 241, 245ECI_GET_REPLY_WAIT 242, 245ECI_GET_SPECIFIC_REPLY_WAIT 245ECI_STATE_ASYNC 242, 246ECI_STATE_ASYNC_MSG 242ECI_STATE_ASYNC_SEM 242ECI_STATE_SYNC 242, 245ECI_SYNC 240, 244ECI_SYNC_CALL 239ECI_SYNC_PARALLEL 240

eci_callback parameterECI-PARMS 244

eci_commarea parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

eci_commarea_length parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

ECI_ERR_ALREADY_ACTIVE return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 240, 241FaaExternalCall 240, 241

ECI_ERR_CALL_FROM_CALLBACK return codeCICS_ECI 244, 245, 246CICS_EciListSystems 246CICS_ExternalCall 244, 245, 246

ECI_ERR_CICS_DIED return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240FaaExternalCall 239, 240

ECI_ERR_EXEC_NOT_RESIDENT return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_INVALID_CALL_TYPE return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_INVALID_DATA_AREA return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246

Index 267

ECI_ERR_INVALID_DATA_AREA return code(continued)

FAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_INVALID_DATA_LENGTH return codeCICS_ECI 244, 245, 246CICS_EciListSystems 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_INVALID_EXTEND_MODE return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_INVALID_TRANSID return codeCICS_ECI 244CICS_ExternalCall 244

ECI_ERR_INVALID_VERSION return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246

ECI_ERR_LUW_TOKEN return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_MORE_SYSTEMS return codeCICS_EciListSystems 246

ECI_ERR_NO_CICS return codeCICS_ECI 244, 245, 246CICS_EciListSystems 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_NO_SESSIONS return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 240, 241FaaExternalCall 240, 241

ECI_ERR_NO_SYSTEMS return codeCICS_EciListSystems 246

ECI_ERR_NULL_MESSAGE_ID return codeFAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_NULL_SEM_HANDLE return codeFAAECI 241, 242FaaExternalCall 241, 242

ECI_ERR_NULL_WIN_HANDLE return codeFAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_REQUEST_TIMEOUT return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_RESOURCE_SHORTAGE return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_RESPONSE_TIMEOUT return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240FaaExternalCall 239, 240

ECI_ERR_ROLLEDBACK return codeCICS_ECI 244CICS_ExternalCall 244

ECI_ERR_SYSTEM_ERROR return codeCICS_ECI 244, 245, 246CICS_EciListSystems 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_THREAD_CREATE_ERROR return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246FAAECI 240, 241, 242FaaExternalCall 240, 241, 242

ECI_ERR_TRANSACTION_ABEND return codeCICS_ECI 244CICS_ExternalCall 244FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

ECI_ERR_UNKNOWN-SERVER return codeCICS_ECI 244, 245, 246CICS_ExternalCall 244, 245, 246

ECI_ERR_UNKNOWN_SERVER return codeFAAECI 242FaaExternalCall 242

eci_extend_mode parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

ECI_GET_REPLY valueeci_call_type 241, 245

ECI_GET_REPLY_WAIT valueeci_call_type 242, 245

ECI_GET_SPECIFIC_REPLY_WAIT valueeci_call_type 245

eci_luw_TOKEN parameterECI-PARMS 240, 241, 242, 244

eci_message_id parameterECI-PARMS 240, 241, 242

eci_message_qualifier parameterECI-PARMS 240, 241, 242, 244, 245, 246

ECI_NO_ERROR return codeCICS_ECI 244, 245, 246CICS_EciListSystems 246CICS_ExternalCall 244, 245, 246FAAECI 239, 240, 241, 242FaaExternalCall 239, 240, 241, 242

268 API Structure

ECI_PARMS parameterCICS_ExternalCall 244FAAECI 239FaaExternalCall 239

eci_password parameterECI-PARMS 239, 240, 241, 244

eci_password2 parameterECI-PARMS 244

eci_program_name parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

ECI_STATE_ASYNC valueeci_call_type 242, 246

ECI_STATE_ASYNC_MSG valueeci_call_type 242

ECI_STATE_ASYNC_SEM valueeci_call_type 242

ECI_STATE_SYNC valueeci_call_type 242, 245

ECI_SYNC valueeci_call_type 240, 244

ECI_SYNC_CALL valueeci_call_type 239

ECI_SYNC_PARALLEL valueeci_call_type 240

eci_sys_return_code parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

eci_system_name parameterECI-PARMS 244, 245, 246

eci_timeout parameterECI-PARMS 239, 240, 241, 242, 244, 245, 246

eci_tpn parameterECI-PARMS 244

eci_transid parameterECI-PARMS 239, 240, 241, 244

eci_userid parameterECI-PARMS 239, 240, 241, 244

eci_userid2 parameterECI-PARMS 244

eci_version parameterECI-PARMS 244, 245, 246

eci_window_handle parameterECI-PARMS 240

EciBlock parameterCICS_ExternalCall 244

ECSCS optionINQUIRE SYSTEM 171SET SYSTEM 175

ECUSHION optionINQUIRE SYSTEM 171SET SYSTEM 175

EDSALIMIT optionINQUIRE SYSTEM 171SET SYSTEM 175

EDSASIZE optionINQUIRE SYSTEM 171

EI optionINQUIRE TRACETYPE 167SET TRACETYPE 168TRACE 54

EIB optionADDRESS 58

ELEMENT optionINQUIRE STORAGE 211

ELEMENTLIST optionINQUIRE STORAGE 211

EMERGENCY CVDAINQUIRE SYSTEM 174

EMPTY CVDAINQUIRE TDQUEUE 226INQUIRE VOLUME 229

EMPTY optionSET FILE 183

EMPTYREQ CVDAINQUIRE FILE 180SET FILE 184

EMPTYSTATUS optionINQUIRE FILE 179, 180INQUIRE TDQUEUE 225, 226INQUIRE VOLUME 229SET FILE 183, 184

ENABLED CVDAINQUIRE AUTOINSTALL 129INQUIRE FILE 180INQUIRE JOURNALNAME 188INQUIRE PROGRAM 198INQUIRE TDQUEUE 226INQUIRE TRANSACTION 222SET FILE 184SET JOURNALNAME 188SET PROGRAM 200SET TDQUEUE 228SET TRANSACTION 224

ENABLESTATUS optionINQUIRE AUTOINSTALL 129INQUIRE FILE 179, 180INQUIRE TDQUEUE 225, 226SET FILE 183, 184SET TDQUEUE 228

ENDAFFINITY CVDASET CONNECTION 138

ENDBR commandaddressed file standard definition 71BDAM (DAM) file standard definition 77conditions

DISABLED 69, 71, 74, 77FILENOTFOUND 69, 71, 74, 77ILLOGIC 69, 71, 74INVREQ 69, 71, 74, 77ISCINVREQ 69, 71, 74, 77NOTAUTH 69, 71, 74, 77NOTOPEN 69, 71, 74SYSIDERR 69, 71, 74, 77

Index 269

ENDBR command (continued)keyed file standard definition 69numbered file standard definition 74options

FILE 69, 71, 74, 77REQID 69, 71, 74, 77SYSID 69, 71, 74, 77

ENDBR optionENDBR 71

ENDDATA conditionRETRIEVE 5, 84

ENDFILE conditionREADNEXT 69, 72, 74, 77READPREV 69, 72, 74

ENDOFDAY optionINQUIRE STATISTICS 209SET STATISTICS 210

ENDOFDAYHRS optionINQUIRE STATISTICS 209SET STATISTICS 210

ENDOFDAYMINS optionINQUIRE STATISTICS 209SET STATISTICS 210

ENDOFDAYSECS optionINQUIRE STATISTICS 209SET STATISTICS 210

EndReason fieldCICS_EpiEventData_t 236

ENQ commandconditions

ENQBUSY 108INVREQ 108

optionsLENGERR 108LENGTH 108LUW 108MAXLIFETIME 108NOSUSPEND 108RESOURCE 108TASK 108

ENQBUSY conditionENQ 108

ENQFAILS optionINQUIRE UOWENQ 206

ENQUEUE optionINQUIRE TRACETYPE 167SET TRACETYPE 168

ENTER optionHANDLE AID 119

ENTER TRACEID commandconditions

INVREQ 54options

FROM 54RESOURCE 54

ENTER TRACEID MONITOR commandconditions

INVREQ 98options

ACCOUNT 98ENTRYNAME 98FROM 98PERFORM 98RESOURCE 98

ENTER TRACENUM commandconditions

INVREQ 53LENGERR 53

optionsEXCEPTION 53FROM 53FROMLENGTH 53RESOURCE 53

ENTRY optionINQUIRE EXITPROGRAM 177LOAD 101

ENTRYNAME optionENTER MONITOR 98INQUIRE EXITPROGRAM 177MONITOR 97

ENTRYPOINT optionINQUIRE PROGRAM 197

ENVDEFERR conditionRETRIEVE 5, 84

EOC conditionRECEIVE MAP 35RECEIVE PARTN 35

EODS conditionRECEIVE MAP 35RECEIVE PARTN 35

EQUAL optionREAD 69RESETBR 70, 75STARTBR 70, 75

ERASE optionCONVERSE 116SEND 116SEND CONTROL 29SEND MAP 30SEND TEXT 30SEND TEXT NOEDIT 31

ERASEAUP optionSEND CONTROL 29SEND MAP 30

ERDSASIZE optionINQUIRE SYSTEM 171

ErrColor fieldCICS_EpiDetails_t 236

ErrHilight fieldCICS_EpiDetails_t 236

270 API Structure

ErrIntensify fieldCICS_EpiDetails_t 236

ErrLastLine fieldCICS_EpiDetails_t 236

ERROROPTION optionINQUIRE TDQUEUE 225, 226

ERRTERM optionROUTE 39

ERSCS optionINQUIRE SYSTEM 171SET SYSTEM 175

ESDS (addressed data sets)base support for 71description of 68

ESDS CVDAINQUIRE FILE 182

ESDSASIZE optionINQUIRE SYSTEM 171

ESMREASON optionCHANGE PASSWORD 24SIGNON 22VERIFY PASSWORD 25

ESMRESP optionCHANGE PASSWORD 24VERIFY PASSWORD 25

ETI-PARMSparameters

eti_partner_lu_name 250eti_password 250eti_return 250eti_termid 250eti_transid 250eti_usage 250eti_userid 250

ETI_ERR_ALLOC_SEG return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_BAD_USAGE return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_FATA_ERROR return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_FREE_SEG return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_GIVE_SEG return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_INVALID_HOST return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_INVALID_TERMINAL return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_INVALID_TRANSID return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_INVALID_USER return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_NO_CICS return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_NO_TERMINAL return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_OPEN_QUEUE return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_PURGED return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_RESOURCE_SHORTAGE return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_SEM_SET return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_UNKNOWN_ERROR return codeFAAETI 249FaaExternalTrans 249

ETI_ERR_WRITE_QUEUE return codeFAAETI 249FaaExternalTrans 249

ETI_NO_ERROR return codeFAAETI 249FaaExternalTrans 249

ETI_PARMS parameterFAAETI 249FaaExternalTrans 249

eti_partner_lu_name parameterETI-PARMS 250

eti_password parameterETI-PARMS 250

eti_return parameterETI-PARMS 250

eti_termid parameterETI-PARMS 250

eti_transid parameterETI-PARMS 250

eti_usage parameterETI-PARMS 250

eti_userid parameterETI-PARMS 250

EUDSASIZE optionINQUIRE SYSTEM 171

EUSCS optionINQUIRE SYSTEM 171SET SYSTEM 175

Index 271

EVENT CVDAINQUIRE MONITOR 193SET MONITOR 194

Event fieldCICS_EpiEventData_t 236

EVENTCLASS optionINQUIRE MONITOR 193SET MONITOR 194

EWASUPP optionASSIGN 61

EXCEPT CVDAINQUIRE MONITOR 193SET MONITOR 194

EXCEPTCLASS optionINQUIRE MONITOR 193SET MONITOR 194

EXCEPTION optionENTER TRACENUM 53

EXCI CVDAINQUIRE CONNECTION 136

EXCI LINK commandconditions

INVREQ 247LENGERR 247LINKERR 247NOTAUTH 247

optionsCOMMAREA 247DATALENGTH 247LENGTH 247PROGRAM 247RETCODE 247SYNCONRETURN 247TRANSID 247

EXCLUSIVE optionINQUIRE FILE 179, 181SET FILE 183, 184

EXCTL CVDAINQUIRE FILE 181SET FILE 184

EXECENQ CVDAINQUIRE UOWENQ 206

EXECENQADDR CVDAINQUIRE UOWENQ 206

EXECKEY optionINQUIRE PROGRAM 197, 198

EXECUTIONSET optionINQUIRE PROGRAM 197, 198SET PROGRAM 199, 200

EXIT optionINQUIRE EXITPROGRAM 177, 178

EXITPROGRAM optionINQUIRE EXITPROGRAM 177

EXITTRACE CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 145

EXITTRACE CVDA (continued)SET CONNECTION 138SET NETNAME 141SET TERMINAL 149

EXITTRACING optionINQUIRE CONNECTION 135, 136INQUIRE TERMINAL 142, 145SET CONNECTION 137, 138SET NETNAME 141SET TERMINAL 148, 149

EXPIRED conditionDELAY 90POST 90

EXPIRYTIME optionVERIFY PASSWORD 25

EXTDS optionASSIGN 61

EXTENDEDDS CVDAINQUIRE TERMINAL 145

EXTENDEDDSST optionINQUIRE TERMINAL 142, 145

EXTRA CVDAINQUIRE TDQUEUE 227

EXTRACT ATTRIBUTES commandconditions

INVREQ 14NOTALLOC 14

optionsCONVID 14STATE 14

EXTRACT LOGONMSG commandconditions

NOTALLOC 121options

INTO 121LENGTH 121SET 121

EXTRACT PROCESS commandconditions

INVREQ 14LENGERR 17NOTALLOC 14

optionsCONVID 14MAXPROCLEN 17PIPLENGTH 16PIPLIST 16PROCLENGTH 14PROCNAME 14SYNCLEVEL 14

EXTSECURITY CVDAINQUIRE SYSTEM 173

272 API Structure

FFAAECI call

parameterECI_PARMS 239

return codesECI_ERR_ALREADY_ACTIVE 240, 241ECI_ERR_CICS_DIED 239, 240ECI_ERR_EXEC_NOT_RESIDENT 239, 240,

241, 242ECI_ERR_INVALID_CALL_TYPE 240, 241, 242ECI_ERR_INVALID_DATA_AREA 240, 241, 242ECI_ERR_INVALID_DATA_LENGTH 239, 240,

241, 242ECI_ERR_INVALID_EXTEND_MODE 239, 240,

241, 242ECI_ERR_LUW_TOKEN 240, 241, 242ECI_ERR_NO_CICS 239, 240, 241, 242ECI_ERR_NO_SESSIONS 240, 241ECI_ERR_NULL_MESSAGE_ID 240, 241, 242ECI_ERR_NULL_SEM_HANDLE 241, 242ECI_ERR_NULL_WIN_HANDLE 240, 241, 242ECI_ERR_REQUEST_TIMEOUT 239, 240, 241,

242ECI_ERR_RESOURCE_SHORTAGE 240, 241,

242ECI_ERR_RESPONSE_TIMEOUT 239, 240ECI_ERR_SYSTEM_ERROR 239, 240, 241,

242ECI_ERR_THREAD_CREATE_ERROR 240,

241, 242ECI_ERR_TRANSACTION_ABEND 239, 240,

241, 242ECI_ERR_UNKNOWN_SERVER 242ECI_NO_ERROR 239, 240, 241, 242

FAAETI callparameter

ETI_PARMS 249return codes

ETI_ERR_ALLOC_SEG 249ETI_ERR_BAD_USAGE 249ETI_ERR_FATAL_ERROR 249ETI_ERR_FREE_SEG 249ETI_ERR_GIVE_SEG 249ETI_ERR_INVALID_HOST 249ETI_ERR_INVALID_TERMINAL 249ETI_ERR_INVALID_TRANSID 249ETI_ERR_INVALID_USER 249ETI_ERR_NO_CICS 249ETI_ERR_NO_TERMINAL 249ETI_ERR_OPEN_QUEUE 249ETI_ERR_PURGED 249ETI_ERR_RESOURCE_SHORTAGE 249ETI_ERR_SEM_SET 249ETI_ERR_UNKNOWN_ERROR 249ETI_ERR_WRITE_QUEUE 249ETI_NO_ERROR 249

FaaExternalCall callparameter

ECI_PARMS 239return codes

ECI_ERR_ALREADY_ACTIVE 240, 241ECI_ERR_CICS_DIED 239, 240ECI_ERR_EXEC_NOT_RESIDENT 239, 240,

241, 242ECI_ERR_INVALID_CALL_TYPE 240, 241, 242ECI_ERR_INVALID_DATA_AREA 240, 241, 242ECI_ERR_INVALID_DATA_LENGTH 239, 240,

241, 242ECI_ERR_INVALID_EXTEND_MODE 239, 240,

241, 242ECI_ERR_LUW_TOKEN 240, 241, 242ECI_ERR_NO_CICS 239, 240, 241, 242ECI_ERR_NO_SESSIONS 240, 241ECI_ERR_NULL_MESSAGE_ID 240, 241, 242ECI_ERR_NULL_SEM_HANDLE 241, 242ECI_ERR_NULL_WIN_HANDLE 240, 241, 242ECI_ERR_REQUEST_TIMEOUT 239, 240, 241,

242ECI_ERR_RESOURCE_SHORTAGE 240, 241,

242ECI_ERR_RESPONSE_TIMEOUT 239, 240ECI_ERR_SYSTEM_ERROR 239, 240, 241,

242ECI_ERR_THREAD_CREATE_ERROR 240,

241, 242ECI_ERR_TRANSACTION_ABEND 239, 240,

241, 242ECI_ERR_UNKNOWN_SERVER 242ECI_NO_ERROR 239, 240, 241, 242

FaaExternalTransreturn codes

ETI_ERR_GIVE_SEG 249ETI_NO_ERROR 249

FaaExternalTrans callparameter

ETI_PARMS 249return codes

ETI_ERR_ALLOC_SEG 249ETI_ERR_BAD_USAGE 249ETI_ERR_FATAL_ERROR 249ETI_ERR_FREE_SEG 249ETI_ERR_INVALID_HOST 249ETI_ERR_INVALID_TERMINAL 249ETI_ERR_INVALID_TRANSID 249ETI_ERR_INVALID_USER 249ETI_ERR_NO_CICS 249ETI_ERR_NO_TERMINAL 249ETI_ERR_OPEN_QUEUE 249ETI_ERR_PURGED 249ETI_ERR_RESOURCE_SHORTAGE 249ETI_ERR_SEM_SET 249ETI_ERR_UNKNOWN_ERROR 249ETI_ERR_WRITE_QUEUE 249

Index 273

FACILITY optionASSIGN 61INQUIRE TASK 213

FACILITYTYPE optionINQUIRE TASK 213, 214

FAILED CVDAINQUIRE JOURNALNAME 188INQUIRE STREAMNAME 191

FAILEDBKOUT CVDAINQUIRE DSNAME 153INQUIRE UOWDSNFAIL 205SET DSNAME 155

FAILINGBKOUT CVDAINQUIRE DSNAME 153

FC optionINQUIRE TRACETYPE 167SET TRACETYPE 168

FCI optionASSIGN 61

FCLOSE CVDAINQUIRE VOLUME 229

FCT optionDUMP 50DUMP TRANSACTION 50

FILE CVDAINQUIRE UOWENQ 206

FILE optionDELETE 68, 71, 73ENDBR 69, 71, 74, 77INQUIRE FILE 179READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78SET FILE 183STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WRITE 71, 73, 76, 78

FILECOUNT optionINQUIRE DSNAME 153

FILENOTFOUND conditionDELETE 68, 71, 73ENDBR 69, 71, 74, 77READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WRITE 71, 73, 76, 78

FILESERVER optionINQUIRE FILE 179SET FILE 183

FINALQUIESCE CVDAINQUIRE SYSTEM 173

FINPUT CVDAINQUIRE VOLUME 229

FIRSTINIT CVDAINQUIRE SYSTEM 173

FIRSTQUIESCE CVDAINQUIRE SYSTEM 173

FIXED CVDAINQUIRE FILE 181INQUIRE TDQUEUE 227

FLENGTH optionDUMP 50DUMP TRANSACTION 50GETMAIN 103INQUIRE STORAGE 211INQUIRE TSQUEUE 219LOAD 101RECEIVE 15, 116SEND 15, 116WRITE JOURNALNAME 95

FLUSH CVDASET JOURNALNAME 188

FMH CVDAINQUIRE REQID 201

FMH optionSTART 85

FMHPARM CVDAINQUIRE TERMINAL 145

FMHPARM optionSEND MAP 33SEND PAGE 33

FMHPARMST optionINQUIRE TERMINAL 142, 145

FMHSTATUS optionINQUIRE REQID 201

FOPEN CVDAINQUIRE VOLUME 229

FOR optionDELAY 90

FORCE PURGE optionSET CONNECTION 137SET TERMINAL 148

FORCE CVDASET DSNAME 155SET FILE 184SET UOW 204

FORCECANCEL CVDASET CONNECTION 138

FORCECLOSE CVDASET VTAM 133

FORCECLOSING CVDAINQUIRE VTAM 132

FORCEPURGE CVDASET CONNECTION 138SET TASK 216

274 API Structure

FORCEPURGE CVDA (continued)SET TERMINAL 149

FORCEUOW CVDASET CONNECTION 138

FORMATEDF CVDAINQUIRE EXITPROGRAM 177

FORMATEDFST optionINQUIRE EXITPROGRAM 177

FORMATTIME commandconditions

INVREQ 88options

ABSTIME 88DATE 88DATEFORM 88DATESEP 88DAYCOUNT 88DAYOFMONTH 88DAYOFWEEK 88DDMMYY 88DDMMYYYY 88MMDDYY 88MMDDYYYY 88MONTHOFYEAR 88TIME 88TIMESEP 88YEAR 88YYDDD 88YYDDMM 88YYMMDD 88YYYYDDD 88YYYYDDMM 88YYYYMMDD 88

FORMFEED CVDAINQUIRE TERMINAL 145

FORMFEED optionSEND CONTROL 29SEND MAP 30SEND TEXT 30

FORMFEEDST optionINQUIRE TERMINAL 142, 145

FOUTPUT CVDAINQUIRE VOLUME 229

FREE commandconditions

INVREQ 14NOTALLOC 14


FREEING CVDAINQUIRE CONNECTION 136

FREEKB optionSEND CONTROL 29SEND MAP 30SEND TEXT 30

FREEKB option (continued)SEND TEXT NOEDIT 31

FREEMAIN commandconditions

INVREQ 103options

DATA 103DATAPOINTER 103

FREQUENCY optionINQUIRE MONITOR 193SET MONITOR 194

FREQUENCYHRS optionINQUIRE MONITOR 193SET MONITOR 194

FREQUENCYMIN optionINQUIRE MONITOR 193SET MONITOR 194

FREQUENCYSEC optionINQUIRE MONITOR 193SET MONITOR 194

FROM optionCONVERSE 14, 116DUMP 50DUMP TRANSACTION 50ENTER MONITOR 98ENTER TRACEID 54ENTER TRACENUM 53ISSUE PASS 120JOURNAL 94RECEIVE MAP 29REWRITE 70, 72, 75, 78SEND 15, 116SEND MAP 30SEND TEXT 30SEND TEXT MAPPED 37SEND TEXT NOEDIT 31START 6, 84WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TD 124WRITEQ TS 112

FROMFLENGTH optionCONVERSE 14, 116

FROMLENGTH optionCONVERSE 14, 116ENTER TRACENUM 53

FRSET optionSEND CONTROL 29SEND MAP 30

FULL CVDAINQUIRE TDQUEUE 226

FULLAPI CVDAINQUIRE PROGRAM 198SET PROGRAM 200

Index 275

FWDRECOVABLE CVDAINQUIRE DSNAME 154INQUIRE FILE 181

FWDRECOVLOG optionINQUIRE DSNAME 153

FWDRECOVLSN optionINQUIRE DSNAME 153

FWDRECSTATUS optionINQUIRE FILE 179, 181

GGAENTRYNAME option

INQUIRE EXITPROGRAM 177GALENGTH option

INQUIRE EXITPROGRAM 177GAUSECOUNT option

INQUIRE EXITPROGRAM 177GC option

INQUIRE TRACETYPE 167SET TRACETYPE 168

GCHARS optionASSIGN 61INQUIRE TERMINAL 142

GCODES optionASSIGN 61INQUIRE TERMINAL 142

GENERIC CVDAINQUIRE CONNECTION 136

GENERIC optionDELETE 68READ 69RESETBR 70STARTBR 70

GETMAIN commandconditions

LENGERR 103NOSTG 103

optionsANY 104BELOW 104CICSDATAKEY 104FLENGTH 103INITIMG 103LENGTH 103NOSUSPEND 103SET 103SHARED 103USERDATAKEY 104

GLOBALCATLG optionINQUIRE TRACETYPE 167SET TRACETYPE 168

GMMI optionASSIGN 61

GMMLENGTH optionINQUIRE SYSTEM 171

GMMLENGTH option (continued)SET SYSTEM 175

GMMTEXT optionINQUIRE SYSTEM 171SET SYSTEM 175

GMMTRANID optionINQUIRE SYSTEM 171

GMT CVDAINQUIRE MONITOR 194

GOINGOUT CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 146

GRNAME optionINQUIRE CONNECTION 135INQUIRE VTAM 132

GROUPID optionSIGNON 22

GRSTATUS optionINQUIRE VTAM 132

GTEQ optionREAD 69RESETBR 70, 75STARTBR 70, 75

GTFSTART CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

GTFSTATUS optionINQUIRE TRACEDEST 163SET TRACEDEST 164

GTFSTOP CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

HHANDLE ABEND command 11

conditionsNOTAUTH 11PGMIDERR 11

optionsCANCEL 11LABEL 11PROGRAM 11RESET 11

HANDLE AID commandoptions

ANYKEY 119CLEAR 119CLRPARTN 119ENTER 119LIGHTPEN 119OPERID 119PA1 to PA3 119PF1 to PF24 119TRIGGER 119

276 API Structure

HANDLE CONDITION command 66HBACKOUT CVDA

INQUIRE UOW 203HCOMMIT CVDA

INQUIRE UOW 203HEADER option

SEND TEXT 37HEX CVDA

INQUIRE FILE 181HFORM CVDA

INQUIRE TERMINAL 145HFORMST option

INQUIRE TERMINAL 142, 145HILIGHT CVDA

INQUIRE TERMINAL 145Hilight field

CICS_EpiDetails_t 236HILIGHT option

ASSIGN 61HILIGHTST option

INQUIRE TERMINAL 142, 145HOLD CVDA

INQUIRE PROGRAM 198HOLD option

LOAD 101HOLDSTATUS option

INQUIRE PROGRAM 197, 198HONEOM option

SEND CONTROL 29SEND MAP 33SEND TEXT 34SEND TEXT NOEDIT 34

HOURS optionDELAY 90INQUIRE REQID 201POST 90ROUTE 40START 6, 84

hWnd parameterCICS_EpiInitialize 234

IIC option


IDLE optionSET DELETSHIPPED 151

IDLEHRS optionSET DELETSHIPPED 151

IDLEMINS optionSET DELETSHIPPED 151

IDLESECS optionSET DELETSHIPPED 151

IGNORE CONDITION command 66

IGNORERR CVDAINQUIRE TDQUEUE 226

IGREQCD conditionSEND CONTROL 29, 33SEND MAP 33, 37SEND PAGE 33SEND TEXT 34SEND TEXT MAPPED 34SEND TEXT NOEDIT 34

IGREQID conditionSEND CONTROL 37, 39SEND MAP 39SEND PAGE 38SEND TEXT 38, 39SEND TEXT MAPPED 38, 39SEND TEXT NOEDIT 38, 39

ILLOGIC conditionDELETE 68, 73ENDBR 69, 71, 74READ 69, 71, 74READNEXT 69, 72, 74READPREV 69, 72, 74RESETBR 70, 72, 75REWRITE 70, 72, 75STARTBR 70, 73, 75UNLOCK 70, 73, 75WRITE 71, 73, 76

IMMCLOSE CVDASET IRC 132SET VTAM 133

IMMCLOSING CVDAINQUIRE IRC 131INQUIRE VTAM 132

IMMEDIATE optionRETURN 100

IMMQUIESCED CVDASET DSNAME 155

INACTIVE CVDAINQUIRE SYSTEM 174

INAUTOACTIVE CVDASET SYSTEM 176

INDEXNAME optionINQUIRE FILE 179SET FILE 183

INDEXRECFULL CVDAINQUIRE UOWDSNFAIL 205

INDIRECT CVDAINQUIRE CONNECTION 135INQUIRE TDQUEUE 227

INDIRECTNAME optionINQUIRE TDQUEUE 225

INDOUBT CVDAINQUIRE TASK 215INQUIRE UOW 203

INDOUBT optionINQUIRE TASK 213, 214

Index 277

INDOUBT option (continued)INQUIRE TDQUEUE 225, 226INQUIRE TRANSACTION 221, 222

INDOUBTMINS optionINQUIRE TASK 213INQUIRE TRANSACTION 221

INDOUBTST optionINQUIRE EXITPROGRAM 177

INDOUBTWAIT optionINQUIRE TASK 213, 214INQUIRE TDQUEUE 225, 226INQUIRE TRANSACTION 221, 222

INFLIGHT CVDAINQUIRE TASK 215INQUIRE UOW 203

INITCOMPLETE CVDAINQUIRE SYSTEM 173

INITIAL CVDAINQUIRE SYSTEM 173

INITIALDDS optionINQUIRE DUMPDS 157SET DUMPDS 157

Initialise_UserDFHXCIS call 247parameters

call_type 247return_area 247user_name 247user_token 247version_number 247

INITIMG optionGETMAIN 103

INITPARM optionASSIGN 61

INITPARMLEN optionASSIGN 62

INITSTATUS optionINQUIRE SYSTEM 171, 173

INPARTN optionASSIGN 62RECEIVE MAP 32

INPUT CVDAINQUIRE TDQUEUE 226

INPUTMSG optionLINK 99RETURN 100XCTL 100

INPUTMSGLEN optionLINK 99RETURN 100XCTL 100

INQUIRE AUTINSTMODEL command 129INQUIRE AUTOINSTALL command 129INQUIRE CONNECTION command 135, 136, 137INQUIRE DSNAME command 153, 154

INQUIRE DUMPDS command 157INQUIRE EXITPROGRAM command 177, 178INQUIRE FILE command 179, 180, 181, 182INQUIRE IRC command 131INQUIRE JOURNALMODEL command 187INQUIRE JOURNALNAME command 187, 188INQUIRE JOURNALNUM command 189, 190INQUIRE MODENAME command 139INQUIRE MONITOR command 193, 194INQUIRE PARTNER command 151INQUIRE PROFILE command 151INQUIRE PROGRAM command 197, 198, 199INQUIRE REQID command 201INQUIRE STATISTICS command 209INQUIRE STORAGE command 211INQUIRE STREAMNAME command 191INQUIRE SYSDUMPCODE command 158INQUIRE SYSTEM command 171, 172, 173, 174INQUIRE TASK command 213, 214, 215INQUIRE TASK LIST command 216INQUIRE TCLASS command 217INQUIRE TDQUEUE command 225, 226, 227INQUIRE TERMINAL command 141, 142, 143, 144,

145, 146, 147INQUIRE TRACEDEST command 163INQUIRE TRACEFLAG command 165INQUIRE TRACETYPE command 167, 168INQUIRE TRANCLASS command 217, 218INQUIRE TRANDUMPCODE command 161INQUIRE TRANSACTION command 221, 222, 223INQUIRE TSQUEUE command 219INQUIRE UOW command 203INQUIRE UOWDSNFAIL command 205INQUIRE UOWENQ command 206INQUIRE UOWLINK command 207INQUIRE VOLUME command 229INQUIRE VTAM command 132INSERVICE CVDA

INQUIRE CONNECTION 136INQUIRE TERMINAL 147SET CONNECTION 138SET TERMINAL 149

INTERVAL optionDELAY 90INQUIRE REQID 201INQUIRE STATISTICS 209POST 90ROUTE 39SET DELETSHIPPED 151SET STATISTICS 210START 6, 84

INTERVALHRS optionINQUIRE STATISTICS 209SET DELETSHIPPED 151SET STATISTICS 210

278 API Structure

INTERVALMINS optionINQUIRE STATISTICS 209SET DELETSHIPPED 151SET STATISTICS 210

INTERVALSECS optionINQUIRE STATISTICS 209SET DELETSHIPPED 151SET STATISTICS 210

INTO optionCONVERSE 14, 116EXTRACT LOGONMSG 121READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RECEIVE 15, 116RECEIVE MAP 29RECEIVE PARTN 32RETRIEVE 5, 84

INTRA CVDAINQUIRE TDQUEUE 227

INTROINTVL optionINQUIRE SYSTEM 171

INTSTART CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

INTSTATUS optionINQUIRE TRACEDEST 163SET TRACEDEST 164

INTSTOP CVDAINQUIRE TRACEDEST 163SET TRACEDEST 164

INVALID CVDAINQUIRE DSNAME 154

INVALIDCOUNT optionVERIFY PASSWORD 25

INVERRTERM conditionROUTE 39

INVITE optionSEND 15, 116

INVLDC conditionROUTE 39SEND CONTROL 29, 33SEND MAP 33SEND TEXT 34

INVMPSZ conditionRECEIVE MAP 29SEND MAP 30

INVOKINGPROGRAM optionASSIGN 62

INVPARTN conditionRECEIVE MAP 32RECEIVE PARTN 32SEND CONTROL 32SEND MAP 32

INVPARTN condition (continued)SEND TEXT 32SEND TEXT NOEDIT 32

INVPARTNSET conditionSEND PARTNSET 32

INVREQ conditionALLOCATE 14CANCEL 5, 83, 89CHANGE PASSWORD 24CHANGE TASK 109CONNECT PROCESS 14CONVERSE 14, 116DELAY 90DELETE 68, 71, 73, 80DELETEQ TD 123DELETEQ TS 111DEQ 107DUMP SYSTEM 52DUMP TRANSACTION 50ENDBR 69, 71, 74, 77ENQ 108ENTER MONITOR 98ENTER TRACEID 54ENTER TRACENUM 53EXCI LINK 247EXTRACT ATTRIBUTES 14EXTRACT PROCESS 14FORMATTIME 88FREE 14FREEMAIN 103ISSUE ABEND 14ISSUE CONFIRMATION 14ISSUE ERROR 14ISSUE PASS 120ISSUE PREPARE 14ISSUE SIGNAL 15LINK 99LOAD 101MONITOR 97POP HANDLE 11, 66, 119POST 90QUERY SECURITY 23READ 69, 71, 74, 77, 80READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RECEIVE 15, 116RECEIVE MAP 29RECEIVE PARTN 32RELEASE 101RESETBR 70, 72, 75, 77RETRIEVE 5, 84RETURN 100REWRITE 70, 72, 75, 78, 80ROUTE 39, 40

Index 279

INVREQ condition (continued)SEND 15, 116SEND CONTROL 29SEND MAP 30, 33SEND PAGE 38, 40SEND PARTNSET 32SEND TEXT 30, 34SEND TEXT MAPPED 37SEND TEXT NOEDIT 31, 32, 34SIGNOFF 20SIGNON 20, 21, 22START 6, 84STARTBR 70, 73, 75, 78SYNCPOINT 105UNLOCK 80VERIFY PASSWORD 25WAIT 15WAIT EVENT 90WAIT EXTERNAL 109WAIT JOURNAL 94WAIT JOURNALNAME 95WAIT JOURNALNUM 93WAITCICS 109WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITEQ TD 124WRITEQ TS 112

INVTSREQ conditionRETRIEVE 5, 84

IOERR conditionDELETE 68, 73DUMP SYSTEM 52DUMP TRANSACTION 50JOURNAL 94READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RESETBR 70, 72, 75, 77RETRIEVE 5, 84REWRITE 70, 72, 75, 78START 6, 84STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WAIT JOURNAL 94WAIT JOURNALNAME 95WAIT JOURNALNUM 93WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TD 124WRITEQ TS 112

IOERROR CVDAINQUIRE UOWDSNFAIL 205

IOTYPE optionINQUIRE TDQUEUE 225, 226

IRC CVDAINQUIRE CONNECTION 135INQUIRE UOWLINK 207

IS optionINQUIRE TRACETYPE 167SET TRACETYPE 168

ISCINVREQ conditionCANCEL 5, 83, 89DELETE 68, 71, 73DELETEQ TD 123DELETEQ TS 111ENDBR 69, 71, 74, 77READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78START 6, 84STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WRITE 71, 73, 76, 78WRITEQ TD 124WRITEQ TS 112

ISOLATE CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

ISOLATEST optionINQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222

ISSUE ABEND commandconditions

INVREQ 14NOTALLOC 14TERMERR 14


ISSUE CONFIRMATION commandconditions



ISSUE COPY commandconditions

LENGERR 118TERMERR 118

optionsCTLCHAR 118TERMID 118WAIT 118

280 API Structure

ISSUE DISCONNECT command 121ISSUE ERASEAUP command

conditionsTERMERR 118

optionsWAIT 118

ISSUE ERORR commandoptions

STATE 14ISSUE ERROR command

conditionsINVREQ 14NOTALLOC 14SIGNAL 14TERMERR 14

optionsCONVID 14

ISSUE PASS commandconditions

INVREQ 120LENGERR 120

optionsFROM 120LENGTH 120LOGMODE 120LOGONLOGMODE 120LUNAME 120NOQUIESCE 120

ISSUE PREPARE commandconditions



ISSUE PRINT commandconditions

TERMERR 118ISSUE SIGNAL command

conditionsINVREQ 15NOTALLOC 15TERMERR 15


ITEM optionREADQ TS 112WRITEQ TS 112

ITEMERR conditionREADQ TS 112WRITEQ TS 112

JJC option


JFILEID optionJOURNAL 94WAIT JOURNAL 94

JIDERR conditionJOURNAL 94WAIT JOURNAL 94WAIT JOURNALNAME 95WAIT JOURNALNUM 93WRITE JOURNALNAME 95WRITE JOURNALNUM 94

JOBNAME optionINQUIRE SYSTEM 171

JOURNAL commandconditions

IOERR 94JIDERR 94LENGERR 94NOJBUFSP 94NOTAUTH 94NOTOPEN 94

optionsFROM 94JFILEID 94JTYPEID 94LENGTH 94NOSUSPEND 94PFXLENG 94PREFIX 94REQID 94STARTIO 94WAIT 94

JOURNALMODEL optionINQUIRE JOURNALMODEL 187

JOURNALNAME optionINQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 187SET JOURNALNAME 188

JOURNALNUM optionINQUIRE FILE 179INQUIRE JOURNALNUM 189INQUIRE VOLUME 229SET JOURNALNUM 190SET VOLUME 230

JTYPE optionINQUIRE JOURNALNUM 189

JTYPEID optionJOURNAL 94WRITE JOURNALNAME 95WRITE JOURNALNUM 94

JUSFIRST optionSEND TEXT 37

Index 281

JUSLAST optionSEND TEXT 37

JUSTIFY optionSEND TEXT 37

KKATAKANA CVDA

INQUIRE TERMINAL 145KATAKANA option

ASSIGN 62KATAKANAST option

INQUIRE TERMINAL 142, 145KC option


KE optionINQUIRE TRACETYPE 167SET TRACETYPE 168

KERNEL optionINQUIRE TRACETYPE 167SET TRACETYPE 168

KEYED CVDAINQUIRE FILE 182

keyed data sets (KSDS)base support for 68description of 68

KEYLENGTH optionDELETE 68INQUIRE FILE 179READ 69, 77READNEXT 69, 77READPREV 69RESETBR 70, 77STARTBR 70, 78WRITE 71, 78

KEYPOSITION optionINQUIRE FILE 179

KSDS (keyed data sets)base support for 68description of 68

KSDS CVDAINQUIRE FILE 182

LL40 option

SEND CONTROL 29SEND MAP 33SEND TEXT 34SEND TEXT NOEDIT 34

L64 optionSEND CONTROL 29SEND MAP 33SEND TEXT 34SEND TEXT NOEDIT 34

L80 optionSEND CONTROL 29SEND MAP 33SEND TEXT 34SEND TEXT NOEDIT 34

LABEL optionHANDLE ABEND 11

LANGINUSE optionASSIGN 62SIGNON 22

LANGUAGE optionINQUIRE PROGRAM 197, 198

LANGUAGECODE optionSIGNON 22

LAST optionSEND 15, 116SEND CONTROL 29, 33SEND MAP 33SEND PAGE 33SEND TEXT 34SEND TEXT MAPPED 34SEND TEXT NOEDIT 34

LASTUSEDINT optionINQUIRE TSQUEUE 219

LASTUSETIME optionVERIFY PASSWORD 25

LC optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LD optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LDC optionROUTE 39SEND CONTROL 29, 33SEND MAP 33SEND TEXT 34

LDCMNEM optionASSIGN 62

LDCNUM optionASSIGN 62

LE370 CVDAINQUIRE PROGRAM 198

LEAVE CVDAINQUIRE TDQUEUE 227

LENGERR conditionCONNECT PROCESS 14, 16CONVERSE 14, 116DEQ 107ENQ 108ENTER TRACENUM 53EOC 14, 15EXCI LINK 247EXTRACT PROCESS 17GETMAIN 103ISSUE COPY 118

282 API Structure

LENGERR condition (continued)ISSUE PASS 120JOURNAL 94LINK 99LOAD 102QUERY SECURITY 23READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RECEIVE 15, 116RECEIVE PARTN 32RETRIEVE 5, 84RETURN 100REWRITE 70, 72, 75, 78SEND 15, 116SEND TEXT 30START 6, 84WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TD 124WRITEQ TS 112XCTL 100

LENGTH optionDEQ 107DUMP 50DUMP TRANSACTION 50ENQ 108EXCI LINK 247EXTRACT LOGONMSG 121GETMAIN 103INQUIRE PROGRAM 197INQUIRE REQID 201ISSUE PASS 120JOURNAL 94LINK 99LOAD 101READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RECEIVE 15, 116RECEIVE MAP 29RECEIVE PARTN 32RETRIEVE 5, 84RETURN 100REWRITE 70, 72, 75, 78SEND 15, 116SEND MAP 30SEND TEXT 30SEND TEXT MAPPED 37SEND TEXT NOEDIT 31START 6, 84

LENGTH option (continued)WRITE 71, 73, 76, 78WRITE JOURNALNUM 94WRITEQ TD 124WRITEQ TS 112XCTL 100

LENGTHLIST optionDUMP TRANSACTION 50INQUIRE STORAGE 211

LG optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LIGHTPEN CVDAINQUIRE TERMINAL 145

LIGHTPEN optionHANDLE AID 119

LIGHTPENST optionINQUIRE TERMINAL 142, 145

LINK commandconditions

INVREQ 99LENGERR 99NOTAUTH 99PGMIDERR 99ROLLEDBACK 99SYSIDERR 99TERMERR 99

optionsAPPLID 247COMMAREA 99DATALENGTH 99INPUTMSG 99INPUTMSGLEN 99LENGTH 99PROGRAM 99SYNCONRETURN 99SYSID 99TRANSID 99

LINK optionINQUIRE UOW 203INQUIRE UOWLINK 207

LINKERR conditionEXCI LINK 247

LINKSYSTEM optionINQUIRE CONNECTION 135INQUIRE TERMINAL 142

LIST optionROUTE 39

list parameterCICS_EciListSystems 246CICS_EpiListSystems 234

LISTSIZE optionINQUIRE TASK LIST 216

LM optionINQUIRE TRACETYPE 167SET TRACETYPE 168

Index 283

LOAD commandconditions

INVREQ 101LENGERR 102NOTAUTH 101PGMIDERR 101

optionsENTRY 101FLENGTH 101HOLD 101LENGTH 101PROGRAM 101SET 101

LOADER optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LOADPOINT optionINQUIRE PROGRAM 197

LOCAL CVDAINQUIRE MONITOR 194INQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

LOCALCATLG optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LOCALE optionINQUIRE SYSTEM 171

LOCATION optionINQUIRE TSQUEUE 219

LOCKED conditionDELETE 80DELETQ TD 125DELETQ TS 113READ 80READNEXT 80, 81READPREV 80, 81READQ TD 125REWRITE 80WRITE 80WRITEQ TD 125WRITEQ TS 113

LOCKMGR optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LOGGER optionINQUIRE TRACETYPE 167SET TRACETYPE 168

LOGICAL CVDAINQUIRE TDQUEUE 227

LOGMESSAGE optionQUERY SECURITY 23

LOGMODE optionISSUE PASS 120

LOGONLOGMODE optionISSUE PASS 120

LOGTERM CVDAINQUIRE SYSTEM 174

LONGDATE optionINQUIRE VOLUME 229

LOSTLOCKS optionINQUIRE DSNAME 153

LPA CVDAINQUIRE PROGRAM 198

LPASTATUS optionINQUIRE PROGRAM 197, 198

LSRPOOLID optionINQUIRE FILE 179SET FILE 183

LU61 CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 147INQUIRE UOWLINK 207

LUNAME optionISSUE PASS 120

LUWDEQ 107

LUW optionENQ 108

MMAIN CVDA

INQUIRE TSQUEUE 219MAIN option

WRITEQ TS 112MAP CVDA

INQUIRE PROGRAM 198MAPCOLUMN option

ASSIGN 62MAPFAIL condition

RECEIVE MAP 29MAPHEIGHT option

ASSIGN 62MAPLINE option

ASSIGN 62MAPNAME option

INQUIRE TERMINAL 142SET TERMINAL 148

MAPONLY optionSEND MAP 30

MAPSET optionRECEIVE MAP 29SEND MAP 30

MAPSETNAME optionINQUIRE TERMINAL 142SET TERMINAL 148

MAPWIDTH optionASSIGN 62

MASSINSERT optionWRITE 71, 73, 76

284 API Structure

MAXACTIVE optionINQUIRE TRANCLASS 217SET TRANCLASS 218

MaxData fieldCICS_EpiDetails_t 236

MAXFLENGTH optionCONVERSE 14, 116RECEIVE 15, 116

MAXIMUM optionINQUIRE MODENAME 139INQUIRE SYSDUMPCODE 158INQUIRE TCLASS 217INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET TCLASS 217SET TRANDUMPCODE 162

MAXITEMLEN optionINQUIRE TSQUEUE 219

MAXLENGTH optionCONVERSE 14, 116RECEIVE 15, 116

MAXLIFETIME optionDEQ 107ENQ 108

MAXNUMRECS optionINQUIRE FILE 179SET FILE 183

MAXPROCLEN optionEXTRACT PROCESS 17

MAXREGIONPOOL optionINQUIRE SYSTEM 171

MAXREQS optionINQUIRE AUTOINSTALL 129SET AUTOINSTALL 130

MAXTASKS optionINQUIRE SYSTEM 171SET SYSTEM 175

MAXTASKSHPOOL optionINQUIRE SYSTEM 171

MAXWINNERS optionINQUIRE MODENAME 139

MCHCTL CVDAINQUIRE TDQUEUE 227

ME optionINQUIRE TRACETYPE 167SET TRACETYPE 168

MEMBERNAME optionINQUIRE CONNECTION 135

MESSAGE optionINQUIRE TRACETYPE 167SET TRACETYPE 168

MINITEMLEN optionINQUIRE TSQUEUE 219

MINUTES optionDELAY 90INQUIRE REQID 201

MINUTES option (continued)POST 90ROUTE 40START 6, 84

MM optionSET TRACETYPE 168

MMDDYY optionFORMATTIME 88

MMDDYYYY optionFORMATTIME 88

MN optionINQUIRE TRACETYPE 167

MOD CVDAINQUIRE TDQUEUE 226

MODEL CVDAINQUIRE TERMINAL 146

MODENAME optionINQUIRE MODENAME 139INQUIRE TERMINAL 142SET MODENAME 140

MONITOR commandconditions

INVREQ 97options

DATA1 97DATA2 97ENTRYNAME 97POINT 97

MONITOR optionINQUIRE TRACETYPE 167

MONTHOFYEAR optionFORMATTIME 88

MROBATCH optionINQUIRE SYSTEM 171SET SYSTEM 175

Msg fieldCICS_EpiSysError_t 237

Msgid parameterCICS_EpiInitialize 234

MSR optionSEND CONTROL 29, 33SEND MAP 33SEND TEXT 34

MSRCONTROL CVDAINQUIRE TERMINAL 146

MSRCONTROL optionASSIGN 62

MSRCONTROLST optionINQUIRE TERMINAL 142, 145

MVS CVDAINQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 188

Index 285

NNAME option

WAIT EVENT 91WAIT EXTERNAL 109WAITCICS 109

Namespace parameterCICS_EciListSystems 246CICS_EpiAddTerminal 234CICS_EpiListSystems 234

NATLANG optionINQUIRE TERMINAL 142SIGNON 21

NATLANGINUSE optionASSIGN 62SIGNON 21

NATURE optionINQUIRE TERMINAL 142, 146

NETBIOS CVDAINQUIRE CONNECTION 135

Netname fieldCICS_EpiDetails_t 236

NETNAME optionASSIGN 62INQUIRE CONNECTION 135INQUIRE PARTNER 151INQUIRE TERMINAL 141INQUIRE UOW 203INQUIRE UOWDSNFAIL 205SET NETNAME 141

NetName parameterCICS_EpiAddTerminal 234

NETUOWID optionINQUIRE UOW 203INQUIRE UOWENQ 206INQUIRE UOWLINK 207

NETWORK optionINQUIRE PARTNER 151

NEWCOPY CVDASET PROGRAM 200

NEWMAXTASKS optionSET SYSTEM 175

NEWPASSWORD optionCHANGE PASSWORD 24SIGNON 20

NEXT optionREADQ TS 112

NEXTTIME optionINQUIRE STATISTICS 209

NEXTTIMEHRS optionINQUIRE STATISTICS 209

NEXTTIMEMINS optionINQUIRE STATISTICS 209

NEXTTIMESECS optionINQUIRE STATISTICS 209

NEXTTRANSID optionASSIGN 62INQUIRE TERMINAL 142SET TERMINAL 148

NLEOM optionROUTE 39SEND MAP 35SEND TEXT 35

NOALTPRTCOPY CVDAINQUIRE TERMINAL 144SET TERMINAL 149

NOAPLKYBD CVDAINQUIRE TERMINAL 144

NOAPLTEXT CVDAINQUIRE TERMINAL 144

NOATI CVDAINQUIRE TERMINAL 144SET TERMINAL 149

NOAUDALARM CVDAINQUIRE TERMINAL 144

NOAUTOARCH CVDAINQUIRE JOURNALNUM 189

NOAUTOPAGE optionSEND PAGE 38

NOBACKOUT CVDAINQUIRE TRANSACTION 222

NOBACKTRANS CVDAINQUIRE TERMINAL 144

NOCEDF CVDAINQUIRE PROGRAM 197SET PROGRAM 199

NOCHECK optionSTART 6, 84

NOCLEAR CVDAINQUIRE TASK 215INQUIRE TRANSACTION 223

NOCMDPROT CVDAINQUIRE SYSTEM 173

NOCOLOR CVDAINQUIRE TERMINAL 144

NOCONVERSE CVDAINQUIRE MONITOR 193SET MONITOR 194

NOCOPY CVDAINQUIRE TERMINAL 145

NOCREATE CVDAINQUIRE TERMINAL 145SET TERMINAL 149

NOCTL CVDAINQUIRE TDQUEUE 227

NODAE CVDAINQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

NODISCREQ CVDAINQUIRE TERMINAL 145SET TERMINAL 149

286 API Structure

NODUALCASE CVDAINQUIRE TERMINAL 145

NODUMP optionABEND 11

NOEMPTYREQ CVDAINQUIRE FILE 180SET FILE 184

NOEVENT CVDAINQUIRE MONITOR 193SET MONITOR 194

NOEXCEPT CVDAINQUIRE MONITOR 193SET MONITOR 194

NOEXCTL CVDAINQUIRE FILE 181SET FILE 184

NOEXITTRACE CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 145SET CONNECTION 138SET NETNAME 141SET TERMINAL 149

NOEXTENDEDDS CVDAINQUIRE TERMINAL 145

NOFLUSH optionSEND MAP 36

NOFMH CVDAINQUIRE REQID 201

NOFMHPARM CVDAINQUIRE TERMINAL 145

NOFORMATEDF CVDAINQUIRE EXITPROGRAM 177

NOFORMFEED CVDAINQUIRE TERMINAL 145

NOHFORM CVDAINQUIRE TERMINAL 145

NOHILIGHT CVDAINQUIRE TERMINAL 145

NOHOLD CVDAINQUIRE PROGRAM 198

NOISOLATE CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

NOJBUFSP conditionJOURNAL 94WRITE JOURNALNAME 95WRITE JOURNALNUM 94

NOKATAKANA CVDAINQUIRE TERMINAL 145

NOLIGHTPEN CVDAINQUIRE TERMINAL 145

NOLOSTLOCKS CVDAINQUIRE DSNAME 154

NOMSRCONTROL CVDAINQUIRE TERMINAL 146

NONAUTOCONN CVDAINQUIRE CONNECTION 136INQUIRE MODENAME 139INQUIRE TERMINAL 144

NONITOR optionSET TRACETYPE 168

NOOBFORMAT CVDAINQUIRE TERMINAL 146SET TERMINAL 149

NOOBOPERID CVDAINQUIRE TERMINAL 146

NOOUTLINE CVDAINQUIRE TERMINAL 146

NOPARTITIONS CVDAINQUIRE TERMINAL 146

NOPERF CVDAINQUIRE MONITOR 193SET MONITOR 195

NOPRESETSEC CVDAINQUIRE TERMINAL 146

NOPRINTADAPT CVDAINQUIRE TERMINAL 146

NOPROGSYMBOL CVDAINQUIRE TERMINAL 146

NOPRTCOPY CVDAINQUIRE TERMINAL 146SET TERMINAL 149

NOQUERY CVDAINQUIRE TERMINAL 146

NOQUEUE optionALLOCATE 14

NOQUIESCE optionISSUE PASS 120

NORECOVDATA CVDAINQUIRE CONNECTION 136SET CONNECTION 138

NOREENTPROT CVDAINQUIRE SYSTEM 173

NORELREQ CVDAINQUIRE TERMINAL 146SET TERMINAL 149

NORETAINED CVDAINQUIRE DSNAME 154

NORMALBKOUT CVDAINQUIRE DSNAME 153SET DSNAME 155

NOSECURITY CVDAINQUIRE SYSTEM 174

NOSHUTDOWN CVDAINQUIRE EXITPROGRAM 178INQUIRE SYSDUMPCODE 158INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET TRANDUMPCODE 162

NOSOSI CVDAINQUIRE TERMINAL 147

Index 287

NOSPACE conditionDUMP SYSTEM 52DUMP TRANSACTION 50REWRITE 70, 72, 75, 78WRITE 71, 73, 76, 78WRITEQ TD 124WRITEQ TS 112

NOSPI CVDAINQUIRE EXITPROGRAM 178

NOSTG conditionDUMP SYSTEM 52DUMP TRANSACTION 50GETMAIN 103

NOSUSPEND optionALLOCATE 14DELETE 80ENQ 108GETMAIN 103JOURNAL 94READ 80READNEXT 80READPREV 80READQ TD 124REWRITE 80WRITE 80WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TS 112

NOSWITCH CVDAINQUIRE DUMPDS 157INQUIRE TRACEDEST 163SET DUMPDS 158SET TRACEDEST 164

NOSYNCPOINT CVDAINQUIRE MONITOR 193SET MONITOR 195

NOSYSDUMP CVDAINQUIRE SYSDUMPCODE 159INQUIRE SYSTEM 173INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET SYSTEM 176SET TRANDUMPCODE 162

NOSYSLOG CVDAINQUIRE STREAMNAME 191

NOTABLE CVDASET FILE 184

NOTADDABLE CVDAINQUIRE FILE 180SET FILE 184

NOTALLOC conditionconditions

NOTALLOC 116, 118, 121CONNECT PROCESS 14CONVERSE 14, 116EXTRACT ATTRIBUTES 14

NOTALLOC condition (continued)EXTRACT LOGONMSG 121EXTRACT PROCESS 14FREE 14ISSUE ABEND 14ISSUE CONFIRMATION 14ISSUE COPY 118ISSUE DISCONNECT 121ISSUE ERASEAUP 118ISSUE ERROR 14ISSUE PREPARE 14ISSUE PRINT 118ISSUE SIGNAL 15RECEIVE 15, 116SEND 15, 116WAIT 15

NOTAPPLIC CVDAINQUIRE CONNECTION 136, 137INQUIRE DSNAME 153, 154INQUIRE EXITPROGRAM 177, 178INQUIRE FILE 180, 181, 182INQUIRE JOURNALNUM 189INQUIRE PROGRAM 197, 198, 199INQUIRE REQID 201INQUIRE SYSTEM 173, 174INQUIRE TDQUEUE 226, 227INQUIRE TERMINAL 144, 145, 147INQUIRE TRACEFLAG 165INQUIRE UOWDSNFAIL 205INQUIRE UOWLINK 207INQUIRE VTAM 132SET FILE 184

NOTASKSTART CVDAINQUIRE EXITPROGRAM 178

NOTAUTH conditionCANCEL 5, 83CHANGE PASSWORD 24DELETE 68, 71, 73DELETEQ TD 123DELETEQ TS 111ENDBR 69, 71, 74, 77EXCI LINK 247HANDLE ABEND 11JOURNAL 94LINK 99LOAD 101READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RELEASE 101RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78SIGNON 20, 21, 22START 6, 84

288 API Structure

NOTAUTH condition (continued)STARTBR 70, 73, 75, 78UNLOCK 73, 75, 78VERIFY PASSWORD 25WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TD 124WRITEQ TS 112XCTL 100

NOTBROWSABLE CVDAINQUIRE FILE 180SET FILE 184

NOTBUSY CVDAINQUIRE TERMINAL 145

NOTCONNECTED CVDAINQUIRE EXITPROGRAM 177

NOTDEFINED CVDAINQUIRE PROGRAM 198

NOTDELETABLE CVDAINQUIRE FILE 180SET FILE 184

NOTEMPTY CVDAINQUIRE TDQUEUE 226INQUIRE VOLUME 229

NOTERMINAL CVDAINQUIRE TDQUEUE 226SET TDQUEUE 228

NOTEXTKYBD CVDAINQUIRE TERMINAL 147

NOTEXTPRINT CVDAINQUIRE TERMINAL 147

NOTFND conditionCANCEL 5, 83, 89DELETE 68, 73QUERY SECURITY 23READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72RESETBR 70, 72, 75, 77RETRIEVE 5, 84STARTBR 70, 73, 75, 78WRITE 78

NOTFWDRCVBLE CVDAINQUIRE FILE 181

NotifyFn parameterCICS_EpiAddTerminal 234

NOTINIT CVDAINQUIRE PROGRAM 198

NOTKEYED CVDAINQUIRE FILE 182

NOTLPA CVDAINQUIRE PROGRAM 198

NOTOPEN conditionDELETE 68, 71, 73DUMP TRANSACTION 50

NOTOPEN condition (continued)ENDBR 69, 71, 74JOURNAL 94READ 69, 71, 74, 77READNEXT 69, 72, 74READPREV 69, 72, 74READQ TD 124RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WAIT JOURNAL 94WAIT JOURNALNAME 95WAIT JOURNALNUM 93WRITE 71, 73, 76, 78WRITE JOURNALNAME 95WRITE JOURNALNUM 94WRITEQ TD 124

NOTPENDING CVDAINQUIRE CONNECTION 136SET CONNECTION 138

NOTPURGEABLE CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222SET TRANSACTION 224

NOTPURGEABLE optionWAIT EXTERNAL 109WAITCICS 109

NOTRANDUMP CVDAINQUIRE TASK 214INQUIRE TRANDUMPCODE 161INQUIRE TRANSACTION 222SET TRANDUMPCODE 162SET TRANSACTION 224

NOTREADABLE CVDAINQUIRE FILE 181SET FILE 184

NOTREADY CVDAINQUIRE JOURNALNUM 189

NOTRECOVABLE CVDAINQUIRE DSNAME 154INQUIRE FILE 181INQUIRE TDQUEUE 227

NOTREQUIRED CVDAINQUIRE PROGRAM 198

NOTRLS CVDAINQUIRE FILE 182INQUIRE UOWDSNFAIL 205SET FILE 184

NOTRUNCATE optionCONVERSE 14, 116RECEIVE 15, 116

NOTSOS CVDAINQUIRE SYSTEM 174

NOTSVA CVDAINQUIRE PROGRAM 199

Index 289

NOTTABLE CVDAINQUIRE FILE 182

NOTTI CVDAINQUIRE TERMINAL 147SET TERMINAL 150

NOTUPDATABLE CVDAINQUIRE FILE 182SET FILE 184

NOUCTRAN CVDAINQUIRE TERMINAL 147SET TERMINAL 150

NOVALIDATION CVDAINQUIRE TERMINAL 147

NOVFORM CVDAINQUIRE TERMINAL 147

NOWAIT CVDAINQUIRE EXITPROGRAM 177INQUIRE TASK 214INQUIRE TDQUEUE 226INQUIRE TRANSACTION 222SET DSNAME 155SET FILE 184

NOWRITE CVDAINQUIRE VOLUME 229SET VOLUME 230

NOZCPTRACE CVDAINQUIRE CONNECTION 137INQUIRE TERMINAL 147SET CONNECTION 138SET TERMINAL 150

NQ optionINQUIRE TRACETYPE 167SET TRACETYPE 168

NRS CVDAINQUIRE CONNECTION 136

numbered data sets (RRDS)base support for 73description of 68

Numcolumns fieldCICS_EpiDetails_t 236

NUMELEMENTS optionINQUIRE STORAGE 211

NUMEVENTS optionWAIT EXTERNAL 109WAITCICS 109

NUMEXITS optionINQUIRE EXITPROGRAM 177

NUMITEMS optionINQUIRE TDQUEUE 225INQUIRE TSQUEUE 219READQ TS 112WRITEQ TS 112

Numlines fieldCICS_EpiDetails_t 236

NUMREC optionDELETE 68

NUMSEGMENTS optionDUMP TRANSACTION 50

NUMTAB optionASSIGN 62

OOBFORMAT CVDA


OBFORMATST optionINQUIRE TERMINAL 142, 146SET TERMINAL 148, 149

OBJECT optionINQUIRE DSNAME 153, 154INQUIRE FILE 179, 181

OBOPERDIST optionINQUIRE TERMINAL 146

OBOPERID CVDAINQUIRE TERMINAL 146

OBOPERIDST optionINQUIRE TERMINAL 142

OBTAINING CVDAINQUIRE CONNECTION 136

OFF CVDAINQUIRE MONITOR 193INQUIRE STATISTICS 209SET MONITOR 195SET STATISTICS 210

OFF optionTRACE 54

OIDCARD optionSIGNON 21

OK CVDAINQUIRE STREAMNAME 191INQUIRE VOLUME 229SET VOLUME 230

OK return codeDFHXCIS 247, 248

OLD CVDAINQUIRE FILE 180INQUIRE TDQUEUE 226SET FILE 184

OLDCOPY CVDASET PROGRAM 200

OLDESTPART optionINQUIRE JOURNALNUM 189

ON CVDAINQUIRE MONITOR 193INQUIRE STATISTICS 209SET MONITOR 195SET STATISTICS 210

ON optionTRACE 54

OPCLASS optionASSIGN 62

290 API Structure

OPCLASS option (continued)ROUTE 39

OPEN CVDAINQUIRE DUMPDS 157INQUIRE FILE 181INQUIRE IRC 131INQUIRE TDQUEUE 226INQUIRE VOLUME 229INQUIRE VTAM 132SET DUMPDS 158SET FILE 184SET IRC 132SET TDQUEUE 228SET VTAM 133

Open_PipeDFHXCIS call 248parameters

call_type 248pipe_token 248return_area 248user_token 248version_number 248

OPENERR conditionDUMP TRANSACTION 50

OPENERROR CVDAINQUIRE UOWDSNFAIL 205

OPENING CVDAINQUIRE FILE 181INQUIRE TDQUEUE 226INQUIRE VOLUME 229

OPENINPUT CVDAINQUIRE JOURNALNUM 190

OPENOUTPUT CVDAINQUIRE JOURNALNUM 190SET JOURNALNUM 190

OPENSTATUS optionINQUIRE DUMPDS 157INQUIRE FILE 179, 181INQUIRE IRC 131INQUIRE JOURNALNUM 189, 190INQUIRE TDQUEUE 225, 226INQUIRE VOLUME 229INQUIRE VTAM 132SET DUMPDS 157, 158SET FILE 183, 184SET IRC 131SET JOURNALNUM 190SET TDQUEUE 228SET VTAM 133

OPERID optionHANDLE AID 119INQUIRE TERMINAL 142

OPERKEYS optionASSIGN 62

OPERPURGE optionSEND PAGE 38

OPID optionASSIGN 62

OPREL optionINQUIRE SYSTEM 172

OPSECURITY optionASSIGN 62

OPSYS optionINQUIRE SYSTEM 172

ORGABCODE optionASSIGN 62

OUTLINE CVDAINQUIRE TERMINAL 146

OUTLINE optionASSIGN 62

OUTLINEST optionINQUIRE TERMINAL 142, 146

OUTPARTN optionSEND CONTROL 32SEND MAP 32SEND TEXT 32SEND TEXT NOEDIT 32

OUTPUT CVDAINQUIRE TDQUEUE 226

OUTSERVICE CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 147SET CONNECTION 138SET TERMINAL 149

OVERFLOW conditionSEND MAP 36

OWNER CVDAINQUIRE UOWENQ 206

PPA option


PA1 to PA3 optionHANDLE AID 119

PAGEABLE CVDAINQUIRE TERMINAL 146SET TERMINAL 149

PAGEHT optionINQUIRE TERMINAL 142

PAGENUM optionASSIGN 62

PAGESTATUS CVDAINQUIRE TERMINAL 146

PAGESTATUS optionINQUIRE TERMINAL 142, 146SET TERMINAL 148, 149

PAGEWD optionINQUIRE TERMINAL 142

PAGING optionSEND CONTROL 37

Index 291

PAGING option (continued)SEND MAP 37SEND TEXT 38SEND TEXT MAPPED 38SEND TEXT NOEDIT 38

PARAMGR optionINQUIRE TRACETYPE 167SET TRACETYPE 168

PART optionINQUIRE VOLUME 229

PARTITIONS CVDAINQUIRE TERMINAL 146

PARTITIONSET CVDAINQUIRE PROGRAM 198

PARTITIONST optionINQUIRE TERMINAL 142, 146

PARTNER optionALLOCATE 17CONNECT PROCESS 17INQUIRE PARTNER 151

PARTNERIDERR conditionALLOCATE 17CONNECT PROCESS 17

PARTNFAIL conditionRECEIVE MAP 32

PARTNPAGE optionASSIGN 62

PARTNS optionASSIGN 62

PARTNSET optionASSIGN 62

PASSWORD optionCHANGE PASSWORD 24SIGNON 20VERIFY PASSWORD 25

PATH CVDAINQUIRE DSNAME 154INQUIRE FILE 181

PC optionINQUIRE TRACETYPE 167SET TRACETYPE 169

PCT optionDUMP 50DUMP TRANSACTION 50

PENDING CVDAINQUIRE CONNECTION 136

PENDSTATUS optionINQUIRE CONNECTION 135, 136SET CONNECTION 137, 138

PERF CVDAINQUIRE MONITOR 193SET MONITOR 195

PERFCLASS optionINQUIRE MONITOR 193SET MONITOR 194

PERFORM optionENTER MONITOR 98

PF1 to PF24 optionHANDLE AID 119

PFXLENG optionJOURNAL 94WRITE JOURNALNAME 95WRITE JOURNALNUM 94

PG optionINQUIRE TRACETYPE 167SET TRACETYPE 169

PGMIDERR conditionHANDLE ABEND 11LINK 99LOAD 101RELEASE 101XCTL 100

pgmname parameterDPL 248

PHASEIN CVDASET PROGRAM 200

PHYSICAL CVDAINQUIRE TDQUEUE 227

pipe_token parameterAllocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Open_Pipe 248

PIPLENGTH optionCONNECT PROCESS 16EXTRACT PROCESS 16

PIPLIST optionCONNECT PROCESS 16EXTRACT PROCESS 16

PLI CVDAINQUIRE PROGRAM 198

POINT optionMONITOR 97

POP HANDLE command 11conditions

INVREQ 11, 66, 119POST command

conditionsEXPIRED 90INVREQ 90

optionsAFTER 90AT 90HOURS 90INTERVAL 90MINUTES 90REQID 90SECONDS 90SET 90TIME 90

292 API Structure

POST CVDAINQUIRE REQID 201

PPT optionDUMP 50DUMP TRANSACTION 50

PREFIX optionJOURNAL 94WRITE JOURNALNAME 95WRITE JOURNALNUM 94

PRESETSEC CVDAINQUIRE TERMINAL 146

PRIMARY CVDAINQUIRE SYSTEM 174

PRINSYSID optionASSIGN 62

PRINT optionSEND CONTROL 29SEND MAP 30SEND TEXT 30SEND TEXT NOEDIT 31

PRINTADAPT CVDAINQUIRE TERMINAL 146

PRINTADAPTST optionINQUIRE TERMINAL 142, 146

PRINTCONTROL optionINQUIRE TDQUEUE 225, 226

Printer fieldCICS_EpiDetails_t 236

PRINTER optionINQUIRE TERMINAL 143SET TERMINAL 148

PRIORITY optionCHANGE TASK 109INQUIRE TASK 213INQUIRE TRANSACTION 221SET TASK 216SET TRANSACTION 223

PRIVATE CVDAINQUIRE PROGRAM 198SET PROGRAM 200

PROCESSID optionINQUIRE TASK 213

PROCLENGTH optionCONNECT PROCESS 14EXTRACT PROCESS 14

PROCNAME optionCONNECT PROCESS 14EXTRACT PROCESS 14

PROFILE optionALLOCATE 14INQUIRE PARTNER 151INQUIRE PROFILE 151INQUIRE TASK 213INQUIRE TRANSACTION 221

PROGAUTOCTLG optionINQUIRE SYSTEM 172, 173

PROGAUTOCTLG option (continued)SET SYSTEM 175, 176

PROGAUTOEXIT optionINQUIRE SYSTEM 172SET SYSTEM 175

PROGAUTOINST optionINQUIRE SYSTEM 172, 173SET SYSTEM 175, 176

PROGMGR optionINQUIRE TRACETYPE 167SET TRACETYPE 169

PROGRAM CVDAINQUIRE PROGRAM 198

PROGRAM optionASSIGN 62DUMP 50DUMP TRANSACTION 50EXCI LINK 247HANDLE ABEND 11INQUIRE AUTOINSTALL 129INQUIRE PROGRAM 197INQUIRE TASK 213INQUIRE TRANSACTION 221LINK 99LOAD 101RELEASE 101SET AUTOINSTALL 130SET PROGRAM 199XCTL 100

PROGSYMBOL CVDAINQUIRE TERMINAL 146

PROGSYMBOLST optionINQUIRE TERMINAL 143, 146

PROGTYPE optionINQUIRE PROGRAM 197, 198

PROTECT optionSTART 6, 84

PROTOCOL optionINQUIRE CONNECTION 135, 136INQUIRE UOWLINK 207

PRTCOPY CVDAINQUIRE TERMINAL 146SET TERMINAL 149

PRTCOPYST optionINQUIRE TERMINAL 143, 146SET TERMINAL 148, 149

PRTYAGING optionINQUIRE SYSTEM 172SET SYSTEM 175

PS optionASSIGN 62

PSDINTERVAL optionINQUIRE VTAM 132SET VTAM 133

PSDINTHRS optionINQUIRE VTAM 132

Index 293

PSDINTHRS option (continued)SET VTAM 133

PSDINTMINS optionINQUIRE VTAM 132SET VTAM 133

PSDINTSECS optionINQUIRE VTAM 132SET VTAM 133

PURGE CVDASET CONNECTION 138SET TASK 216SET TERMINAL 149

PURGE MESSAGE commandconditions

TSIOERR 37PURGEABILITY option

INQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222SET TRANSACTION 223, 224WAIT EXTERNAL 109WAITCICS 109

PURGEABLE CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222SET TRANSACTION 224

PURGEABLE optionWAIT EXTERNAL 109WAITCICS 109

PURGEBMS optionSET TERMINAL 148

PURGETHRESH optionINQUIRE TRANCLASS 217SET TRANCLASS 218

PURGETYPE optionSET CONNECTION 137, 138SET TASK 216SET TERMINAL 148, 149

PUSH HANDLE command 11, 66

QQBUSY condition

READQ TD 124QIDERR condition

DELETEQ TD 123DELETEQ TS 111QUERY SECURITY 23READQ TD 124READQ TS 112WRITEQ TD 124WRITEQ TS 112

QNAME optionASSIGN 62

QUALIFIER optionINQUIRE EXITPROGRAM 177INQUIRE UOWENQ 206

QUALLEN optionINQUIRE UOWENQ 206

QUERY SECURITY commandconditions

INVREQ 23LENGERR 23NOTFND 23QIDERR 23

optionsALTER 23CONTROL 23LOGMESSAGE 23READ 23RESCLASS 23RESID 23RESIDLENGTH 23RESTYPE 23UPDATE 23

QUERYST optionINQUIRE TERMINAL 143, 146

QUEUE CVDAINQUIRE TDQUEUE 226

QUEUE optionDELETEQ TD 123DELETEQ TS 111INQUIRE REQID 201READQ TD 124READQ TS 112RETRIEVE 5, 84START 6, 84WRITEQ TD 124WRITEQ TS 112

QUEUED optionINQUIRE TRANCLASS 217

QUIESCED CVDAINQUIRE DSNAME 154SET DSNAME 155

QUIESCESTATE optionINQUIRE DSNAME 153, 154SET DSNAME 155

QUIESCING CVDAINQUIRE DSNAME 154

QZERO conditionREADQ TD 124

RRBA option

DELETE 71, 79READ 71, 79READNEXT 72, 79READPREV 72, 79RESETBR 72, 79STARTBR 73, 79WRITE 73, 79

294 API Structure

RDATT conditionRECEIVE MAP 35

RDSASIZE optionINQUIRE SYSTEM 172

READ optionUNLOCK 75WRITE 76

READ commandaddressed file standard definition 71BDAM (DAM) file standard definition 77conditions

DISABLED 69, 71, 74, 77DUPKEY 69FILENOTFOUND 69, 71, 74, 77ILLOGIC 69, 71, 74INVREQ 69, 71, 74, 77, 80IOERR 69, 71, 74, 77ISCINVREQ 69, 71, 74, 77LENGERR 69, 71, 74, 77LOCKED 80NOTAUTH 69, 71, 74, 77NOTFND 69, 71, 74, 77NOTOPEN 69, 71, 74, 77RECORDBUSY 80SYSIDERR 69, 71, 74, 77


CONSISTENT 80DEBKEY 77DEBREC 77EQUAL 69FILE 69, 71, 74, 77GENERIC 69GTEQ 69INTO 69, 71, 74, 77KEYLENGTH 69, 77LENGTH 69, 71, 74, 77NOSUSPEND 80RBA 71, 79REPEATABLE 80RIDFLD 69, 71, 74, 77RRN 74SET 69, 71, 74, 77SYSID 69, 71, 74, 77TOKEN 80UNCOMMITTED 80UPDATE 69, 71, 74, 77

READ optionINQUIRE FILE 179, 181QUERY SECURITY 23SET FILE 183, 184

READABLE CVDAINQUIRE FILE 181SET FILE 184

READBACK CVDAINQUIRE TDQUEUE 226

READINTEG optionINQUIRE FILE 179, 181SET FILE 183, 184

READNEXT commandaddressed file standard definition 72BDAM (DAM) file standard definition 77conditions

DISABLED 69, 72, 74DUPKEY 69ENDFILE 69, 72, 74, 77FILENOTFOUND 69, 72, 74, 77ILLOGIC 69, 72, 74INVREQ 69, 72, 74, 77IOERR 69, 72, 74, 77ISCINVREQ 69, 72, 74, 77LENGERR 69, 72, 74, 77LOCKED 80, 81NOTAUTH 69, 72, 74, 77NOTFND 69, 72, 74, 77NOTOPEN 69, 72, 74RECORDBUSY 80SYSIDERR 69, 72, 74, 77


CONSISTENT 80FILE 69, 72, 74, 77INTO 69, 72, 74, 77KEYLENGTH 69, 77LENGTH 69, 72, 74, 77NOSUSPEND 80RBA 72, 79REPEATABLE 80REQID 69, 72, 74, 77RIDFLD 69, 72, 74, 77RRN 74SET 69, 72, 74, 77SYSID 69, 72, 74, 77TOKEN 81UNCOMMITTED 80UPDATE 81

READONLY CVDAINQUIRE VOLUME 229SET VOLUME 230

READPREV commandaddressed file standard definition 72conditions

DISABLED 69, 72, 74DUPKEY 69ENDFILE 69, 72, 74FILENOTFOUND 69, 72, 74ILLOGIC 69, 72, 74INVREQ 69, 72, 74IOERR 69, 72, 74ISCINVREQ 69, 72, 74

Index 295

READPREV command (continued)conditions (continued)

LENGERR 69, 72, 74LOCKED 80, 81NOTAUTH 69, 72, 74NOTFND 69, 72NOTOPEN 69, 72, 74RECORDBUSY 80SYSIDERR 69, 72, 74


CONSISTENT 80FILE 69, 72, 74INTO 69, 72, 74KEYLENGTH 69LENGTH 69, 72, 74NOSUSPEND 80RBA 72, 79REPEATABLE 80REQID 69, 72, 74RIDFLD 69, 72, 74RRN 74SET 69, 72, 74SYSID 69, 72, 74TOKEN 81UNCOMMITTED 80UPDATE 81

READQ TD commandconditions

DISABLED 124INVREQ 124IOERR 124ISCINVREQ 124LENGERR 124LOCKED 125NOTAUTH 124NOTOPEN 124QBUSY 124QIDERR 124QZERO 124SYSIDERR 124

optionsINTO 124LENGTH 124NOSUSPEND 124QUEUE 124SET 124SYSID 124

READQ TS commandconditions

INVREQ 112IOERR 112ISCINVREQ 112ITEMERR 112LENGERR 112NOTAUTH 112

READQ TS command (continued)conditions (continued)

QIDERR 112SYSIDERR 112

optionsINTO 112ITEM 112LENGTH 112NEXT 112NUMITEMS 112QUEUE 112SET 112SYSID 112

READY CVDAINQUIRE JOURNALNUM 189

REASON optionINQUIRE UOWDSNFAIL 205

RECEIVE commandadvanced program-to-program communication

(APPC) mapped 15conditions

INVREQ 15, 116LENGERR 15, 116NOTALLOC 15SIGNAL 15TERMERR 15, 116

optionsASIS 116BUFFER 116CONVID 15FLENGTH 15, 116INTO 15, 116LENGTH 15, 116MAXFLENGTH 15, 116MAXLENGTH 15, 116NOTRUNCATE 15, 116SET 15, 116STATE 15

terminal control (3270) 116RECEIVE MAP command

conditionsEOC 35EODS 35INVMPSZ 29INVPARTN 32INVREQ 29MAPFAIL 29PARTNFAIL 32RDATT 35UNEXPIN 35

optionsASIS 29FROM 29INPARTN 32INTO 29LENGTH 29MAPSET 29

296 API Structure

RECEIVE MAP command (continued)options (continued)

SET 29TERMINAL 29

RECEIVE PARTN commandconditions

EOC 35EODS 35INVPARTN 32INVREQ 32LENGERR 32

optionsASIS 32INTO 32LENGTH 32SET 32

RECEIVECOUNT optionINQUIRE CONNECTION 135

RECORDBUSY conditionDELETE 80READ 80READNEXT 80READPREV 80REWRITE 80WRITE 80

RECORDFORMAT optionINQUIRE FILE 179, 181INQUIRE TDQUEUE 225, 227

RECORDING optionINQUIRE STATISTICS 209SET STATISTICS 210

RECORDLENGTH optionINQUIRE TDQUEUE 225

RECORDNOW optionSET STATISTICS 210

RECORDSIZE optionINQUIRE FILE 179

RECOVDATA CVDAINQUIRE CONNECTION 136

RECOVERABLE CVDAINQUIRE DSNAME 154INQUIRE FILE 181

RECOVERED CVDASET DSNAME 155

RECOVERLOCKS CVDAINQUIRE DSNAME 154

RECOVERY optionINQUIRE TRACETYPE 167SET TRACETYPE 169

RECOVSTATUS optionINQUIRE CONNECTION 135, 136INQUIRE DSNAME 153, 154INQUIRE FILE 179, 181INQUIRE TDQUEUE 225, 227SET CONNECTION 137, 138

RECUNITID optionINQUIRE TASK 213

REENTPROT CVDAINQUIRE SYSTEM 173

REENTPROTECT optionINQUIRE SYSTEM 172, 173

REGERROR CVDAINQUIRE VTAM 132

REGIONTHRESH optionINQUIRE SYSTEM 172

REGISTERED CVDAINQUIRE VTAM 132

REJECT CVDAINQUIRE TDQUEUE 226

RELATED CVDAINQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

RELATION optionINQUIRE UOWENQ 206

relative record data set (RRDS) 73RELEASE command

conditionsINVREQ 101NOTAUTH 101PGMIDERR 101

optionsPROGRAM 101

RELEASE optionINQUIRE SYSTEM 172SEND PAGE 38

RELEASED CVDAINQUIRE CONNECTION 136INQUIRE TERMINAL 144, 147SET CONNECTION 138SET TERMINAL 149

RELEASING CVDAINQUIRE TERMINAL 147

RELREQ CVDAINQUIRE TERMINAL 146SET TERMINAL 149

RELREQST optionINQUIRE TERMINAL 143, 146SET TERMINAL 148, 149

RELTYPE optionINQUIRE FILE 179, 181

REMLOSTLOCKS CVDAINQUIRE DSNAME 154

REMOTE CVDAINQUIRE FILE 180INQUIRE TDQUEUE 227

REMOTENAME optionINQUIRE CONNECTION 135INQUIRE FILE 179INQUIRE PROGRAM 197INQUIRE TASK 213INQUIRE TDQUEUE 225

Index 297

REMOTENAME option (continued)INQUIRE TERMINAL 143INQUIRE TRANSACTION 221

REMOTESYSNET optionINQUIRE CONNECTION 135INQUIRE TERMINAL 143

REMOTESYSTEM optionINQUIRE CONNECTION 135INQUIRE FILE 179INQUIRE PROGRAM 197INQUIRE TASK 213INQUIRE TDQUEUE 225INQUIRE TERMINAL 143INQUIRE TRANSACTION 221

REMOVE CVDASET DSNAME 155SET SYSDUMPCODE 160SET TRANDUMPCODE 162SET VOLUME 230

REMSESSION CVDAINQUIRE TERMINAL 146

REPEATABLE CVDAINQUIRE FILE 181SET FILE 184

REPEATABLE optionREAD 80READNEXT 80READPREV 80

REQID optionCANCEL 5, 83, 89DELAY 90ENDBR 69, 71, 74, 77INQUIRE REQID 201JOURNAL 94POST 90READNEXT 69, 72, 74, 77READPREV 69, 72, 74RESETBR 70, 72, 75, 77ROUTE 39SEND CONTROL 37, 39SEND MAP 37, 39SEND TEXT 38, 39SEND TEXT MAPPED 38, 39SEND TEXT NOEDIT 38, 39START 6, 84STARTBR 70, 73, 75, 78WAIT JOURNAL 94WAIT JOURNALNAME 95WAIT JOURNALNUM 93WRITE JOURNALNAME 95WRITE JOURNALNUM 94

REQTYPE optionINQUIRE REQID 201

REQUIRED CVDAINQUIRE PROGRAM 198

REREAD CVDAINQUIRE TDQUEUE 227

RESCLASS optionQUERY SECURITY 23

RESCOUNT optionINQUIRE PROGRAM 197

RESET CVDASET JOURNALNAME 188SET SYSDUMPCODE 160SET TRANDUMPCODE 162

RESET optionHANDLE ABEND 11SET FILE 183

RESETBR commandaddressed file standard definition 72BDAM (DAM) file standard definition 77conditions

DISABLED 70, 72, 75, 77FILENOTFOUND 70, 72, 75, 77ILLOGIC 70, 72, 75INVREQ 70, 72, 75, 77IOERR 70, 72, 75, 77ISCINVREQ 70, 72, 75, 77NOTAUTH 70, 72, 75, 77NOTFND 70, 72, 75, 77NOTOPEN 70, 72, 75, 77SYSIDERR 70, 72, 75, 77


EQUAL 70, 75FILE 70, 72, 75, 77GENERIC 70GTEQ 70, 75KEYLENGTH 70, 77RBA 72, 79REQID 70, 72, 75, 77RIDFLD 70, 72, 75, 77RRN 75SYSID 70, 72, 75, 77

RESETLOCKS CVDASET DSNAME 155

RESETNOW optionSET STATISTICS 210

RESID optionQUERY SECURITY 23

RESIDLENGTH optionQUERY SECURITY 23

RESLEN optionINQUIRE UOWENQ 206

RESOURCE optionDEQ 107ENQ 108ENTER MONITOR 98ENTER TRACEID 54ENTER TRACENUM 53

298 API Structure

RESOURCE option (continued)INQUIRE UOWENQ 206

RESSEC optionASSIGN 62INQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222

RESSECEXT CVDAINQUIRE TRANSACTION 222

RESSECNO CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

RESSECYES CVDAINQUIRE TASK 214INQUIRE TRANSACTION 222

RESTART optionASSIGN 62

RESTYPE optionQUERY SECURITY 23

RESYNC CVDASET CONNECTION 138

RESYNCSTATUS optionINQUIRE UOWLINK 207

RETAIN optionSEND PAGE 38

RETAINED CVDAINQUIRE DSNAME 154INQUIRE UOWENQ 206

RETCODE optionEXCI LINK 247

RETLOCKS optionINQUIRE DSNAME 153, 154

RETPAGE conditionSEND CONTROL 36SEND MAP 36SEND PAGE 36SEND TEXT 37

RETRIEVE commandconditions

ENDDATA 5, 84ENVDEFERR 5, 84INVREQ 5, 84INVTSREQ 5, 84IOERR 5, 84LENGERR 5, 84NOTFND 5, 84

optionsINTO 5, 84LENGTH 5, 84QUEUE 5, 84RTERMID 5, 84RTRANSID 5, 84SET 5, 84WAIT 5, 84

RETRY CVDASET DSNAME 155

RETRYABLE return codeDFHXCIS 247, 248

RETURN commandconditions

INVREQ 100LENGERR 100

optionsCOMMAREA 100IMMEDIATE 100INPUTMSG 100INPUTMSGLEN 100LENGTH 100TRANSID 100

return_area parameterAllocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Initialise_User 247Open_Pipe 248

RETURNPROG optionASSIGN 62

REVERTED CVDAINQUIRE JOURNALNUM 189

REWIND optionINQUIRE TDQUEUE 225, 227

REWRITE commandaddressed file standard definition 72BDAM (DAM) file standard definition 78conditions

DISABLED 70, 72, 75, 78DUPREC 70, 72, 75FILENOTFOUND 70, 72, 75, 78ILLOGIC 70, 72, 75INVREQ 70, 72, 75, 78, 80IOERR 70, 72, 75, 78ISCINVREQ 70, 72, 75, 78LENGERR 70, 72, 75, 78LOCKED 80NOSPACE 70, 72, 75, 78NOTAUTH 70, 72, 75, 78NOTOPEN 70, 72, 75, 78RECORDBUSY 80SYSIDERR 70, 72, 75, 78


FILE 70, 72, 75, 78FROM 70, 72, 75, 78LENGTH 70, 72, 75, 78NOSUSPEND 80SYSID 70, 72, 75, 78TOKEN 80

REWRITE optionWRITEQ TS 112

Index 299

RI optionINQUIRE TRACETYPE 167SET TRACETYPE 169

RIDFLD optionDELETE 68, 71, 73READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74RESETBR 70, 72, 75, 77STARTBR 70, 73, 75, 78WRITE 71, 73, 76, 78

RLS CVDAINQUIRE FILE 182INQUIRE UOWDSNFAIL 205SET FILE 184

RLSACCESS optionINQUIRE FILE 179, 181INQUIRE UOWDSNFAIL 205SET FILE 183, 184

RLSACTIVE CVDAINQUIRE SYSTEM 173

RLSGONE CVDAINQUIRE UOWDSNFAIL 205

RLSINACTIVE CVDAINQUIRE SYSTEM 173

RLSSERVER CVDAINQUIRE UOW 203INQUIRE UOWDSNFAIL 205

RLSSTATUS optionINQUIRE SYSTEM 172, 173

RM optionINQUIRE TRACETYPE 167SET TRACETYPE 169

RMI CVDAINQUIRE UOWLINK 207

RMI optionINQUIRE TRACETYPE 167SET TRACETYPE 169

RMIQFY optionINQUIRE UOWLINK 207

ROLE optionINQUIRE UOWLINK 207

ROLLBACK optionSYNCPOINT 105

ROLLEDBACK conditionLINK 99SYNCPOINT 105

ROUTE commandconditions

INVERRTERM 39INVLDC 39INVREQ 39, 40RTEFAIL 39RTESOME 39

optionsAFTER 40AT 40

ROUTE command (continued)options (continued)

ERRTERM 39HOURS 40INTERVAL 39LDC 39LIST 39MINUTES 40NLEOM 39OPCLASS 39REQID 39SECONDS 40TIME 39TITLE 39

ROUTE CVDAINQUIRE REQID 201

ROUTING optionINQUIRE TASK 213, 214INQUIRE TRANSACTION 221, 222

RPG CVDAINQUIRE PROGRAM 198

RRDS (numbered data sets)base support for 73description of 68

RRDS (relative record data set) 73RRDS CVDA

INQUIRE FILE 182RRN option

DELETE 73READ 74READNEXT 74READPREV 74RESETBR 75STARTBR 75WRITE 76

RTEFAIL conditionROUTE 39

RTERMID optionINQUIRE REQID 201RETRIEVE 5, 84START 6, 84

RTESOME conditionROUTE 39

RTIMEOUT optionINQUIRE TASK 213INQUIRE TRANSACTION 221

RTRANSID optionINQUIRE REQID 201RETRIEVE 5, 84START 6, 84

RUNAWAY optionINQUIRE SYSTEM 172INQUIRE TASK 213INQUIRE TRANSACTION 221SET SYSTEM 175SET TRANSACTION 223

300 API Structure

RUNAWAYTYPE optionINQUIRE TRANSACTION 221, 222SET TRANSACTION 223, 224

RUNNING CVDAINQUIRE TASK 215

RUNNING optionINQUIRE TASK LIST 216

RUNSTATUS optionINQUIRE TASK 213, 215

SSC option


SCANDELAY optionINQUIRE SYSTEM 172SET SYSTEM 175

SCREENHEIGHT optionINQUIRE TERMINAL 143

SCREENWIDTH optionINQUIRE TERMINAL 143

SCRNHT optionASSIGN 62INQUIRE TERMINAL 143

SCRNSIZE optionINQUIRE TASK 213, 215INQUIRE TRANSACTION 221, 222

SCRNWD optionASSIGN 62INQUIRE TERMINAL 143

SCS CVDAINQUIRE TERMINAL 145

SDSASIZE optionINQUIRE SYSTEM 172

SDTRAN optionINQUIRE SYSTEM 172

SECONDINIT CVDAINQUIRE SYSTEM 173

SECONDS optionDELAY 90INQUIRE REQID 201POST 90ROUTE 40START 6, 84

SECURITY optionINQUIRE TERMINAL 143, 146INQUIRE TRACETYPE 168SET TRACETYPE 169

SECURITYMGR optionINQUIRE SYSTEM 172, 173

SEGMENTLIST optionDUMP TRANSACTION 50

SEND commandadvanced program-to-program communication

(APPC) mapped 15

SEND command (continued)conditions

INVREQ 15, 116LENGERR 15, 116NOTALLOC 15SIGNAL 15TERMERR 15, 116

optionsALTERNATE 119CONFIRM 15CONVID 15CTLCHAR 116DEFAULT 119DEFRESP 116ERASE 116FLENGTH 15, 116FROM 15, 116INVITE 15, 116LAST 15, 116LENGTH 15, 116STATE 15STRFIELD 116WAIT 15, 116

terminal control (3270) 116SEND CONTROL command

conditionsIGREQCD 29, 33IGREQID 37, 39INVLDC 29, 33INVPARTN 32INVREQ 29RETPAGE 36TSIOERR 37, 39WRBRK 29, 33

optionsACCUM 36ACTPARTN 32ALARM 29ALTERNATE 36CURSOR 29DEFAULT 36ERASE 29ERASEAUP 29FORMFEED 29FREEKB 29FRSET 29HONEOM 29L40 29L64 29L80 29LAST 29, 33LDC 29, 33MSR 29, 33OUTPARTN 32PAGING 37PRINT 29REQID 37, 39

Index 301

SEND CONTROL command (continued)options (continued)

SET 36TERMINAL 36WAIT 29

SEND MAP commandconditions

IGREQCD 33, 37IGREQID 39INVLDC 33INVMPSZ 30INVPARTN 32INVREQ 30, 33OVERFLOW 36RETPAGE 36TSIOERR 37, 39WRBRK 33

optionsACCUM 36ACTPARTN 32ALARM 30ALTERNATE 36CURSOR 30DATAONLY 30DEFAULT 36ERASE 30ERASEAUP 30FMHPARM 33FORMFEED 30FREEKB 30FROM 30FRSET 30HONEOM 33L40 33L64 33L80 33LAST 33LDC 33LENGTH 30MAPONLY 30MAPSET 30MSR 33NLEOM 35NOFLUSH 36OUTPARTN 32PAGING 37PRINT 30REQID 37, 39SET 36TERMINAL 36WAIT 30

SEND PAGE commandconditions

IGREQCD 33IGREQID 38INVREQ 38, 40RETPAGE 36

SEND PAGE command (continued)conditions (continued)

TSIOERR 38options

ALL 33AUTOPAGE 38CURRENT 33FMHPARM 33LAST 33NOAUTOPAGE 38OPERPURGE 38RELEASE 38RETAIN 38SET 36TRAILER 36TRANSID 40

SEND PARTNSET commandconditions

INVPARTNSET 32INVREQ 32

SEND TEXT commandconditions

IGREQCD 34IGREQID 38, 39INVLDC 34INVPARTN 32INVREQ 30, 34LENGERR 30RETPAGE 37TSIOERR 38, 39WRBRK 34

optionsACCUM 37ACTPARTN 32ALARM 30ALTERNATE 36CURSOR 30DEFAULT 36ERASE 30FORMFEED 30FREEKB 30FROM 30HEADER 37HONEOM 34JUSFIRST 37JUSLAST 37JUSTIFY 37L40 34L64 34L80 34LAST 34LDC 34LENGTH 30MSR 34NLEOM 35OUTPARTN 32PAGING 38

302 API Structure

SEND TEXT command (continued)options (continued)

PRINT 30REQID 38, 39SET 37TERMINAL 37TRAILER 37WAIT 30

SEND TEXT MAPPED commandconditions

IGREQCD 34IGREQID 38, 39INVREQ 37TSIOERR 38, 39WRBRK 34

optionsFROM 37LAST 34LENGTH 37PAGING 38REQID 38, 39TERMINAL 37WAIT 34

SEND TEXT NOEDIT commandconditions

IGREQCD 34IGREQID 38, 39INVPARTN 32INVREQ 31, 32, 34TSIOERR 38, 39WRBRK 34

optionsALARM 31ERASE 31FREEKB 31FROM 31HONEOM 34L40 34L64 34L80 34LAST 34LENGTH 31OUTPARTN 32PAGING 38PRINT 31REQID 38, 39WAIT 34

SENDCOUNT optionINQUIRE CONNECTION 135

SenseCode parameterCICS_EpiSenseCode 235

SERVSTATUS optionINQUIRE CONNECTION 135, 136INQUIRE TERMINAL 143, 146SET CONNECTION 137, 138SET TERMINAL 148, 149

SESSION CVDAINQUIRE TERMINAL 146

SESSIONTYPE optionINQUIRE TERMINAL 143, 147

SET AUTOINSTALL command 130SET CONNECTION command 137, 138SET DELETSHIPPED command 151SET DSNAME command 155SET DUMPDS command 157, 158SET FILE command 183, 184SET IRC command 131SET JOURNALNAME command 188SET JOURNALNUM command 190SET MODENAME command 140SET MONITOR command 194, 195SET NETNAME command 141SET option

ADDRESS 60CONVERSE 14, 116EXTRACT LOGONMSG 121GETMAIN 103INQUIRE REQID 201INQUIRE TASK LIST 216LOAD 101POST 90READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RECEIVE 15, 116RECEIVE MAP 29RECEIVE PARTN 32RETRIEVE 5, 84SEND CONTROL 36SEND MAP 36SEND PAGE 36SEND TEXT 37

SET PROGRAM command 199, 200SET STATISTICS command 210SET SYSDUMPCODE command 160SET SYSTEM command 175, 176SET TASK command 216SET TCLASS command 217SET TDQUEUE command 228SET TERMINAL command 148, 149, 150SET TRACEDEST command 164SET TRACEFLAG command 166SET TRACETYPE command 168, 169SET TRANCLASS command 218SET TRANDUMPCODE command 162SET TRANSACTION command 223, 224SET UOW command 204SET UOWLINK command 208SET VOLUME command 230

Index 303

SET VTAM command 133SETTRANSID option

INQUIRE TASK LIST 216SFS CVDA

INQUIRE FILE 180SHARE CVDA

INQUIRE FILE 180SET FILE 184

SHARED CVDAINQUIRE PROGRAM 198SET PROGRAM 200

SHARED optionGETMAIN 103

SHARESTATUS optionINQUIRE PROGRAM 197, 198SET PROGRAM 199, 200

SHR CVDAINQUIRE TDQUEUE 226

SHUNTED CVDAINQUIRE UOW 204

SHUTDISABLED CVDAINQUIRE TRANSACTION 222SET TRANSACTION 224

SHUTDOWN CVDAINQUIRE EXITPROGRAM 178INQUIRE SYSDUMPCODE 158INQUIRE SYSTEM 174INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET TRANDUMPCODE 162

SHUTDOWN optionINQUIRE TRANSACTION 221, 222SET TRANSACTION 223, 224

SHUTDOWNST optionINQUIRE EXITPROGRAM 177, 178

SHUTENABLED CVDAINQUIRE TRANSACTION 222SET TRANSACTION 224

SHUTOPTION optionINQUIRE SYSDUMPCODE 158INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET TRANDUMPCODE 162

SHUTSTATUS optionINQUIRE SYSTEM 172, 174

SIGDATA optionASSIGN 62

SIGNAL conditionCONVERSE 14ISSUE ERROR 14RECEIVE 15SEND 15

SIGNEDOFF CVDAINQUIRE TERMINAL 147

SIGNEDON CVDAINQUIRE TERMINAL 147

SIGNOFF commandconditions

INVREQ 20SIGNON command

conditionsINVREQ 20, 21, 22NOTAUTH 20, 21, 22USERIDERR 20

optionsESMREASON 22ESMRESP 22GROUPID 22LANGINUSE 22LANGUAGECODE 22NATLANG 21NATLANGINUSE 21NEWPASSWORD 20OIDCARD 21PASSWORD 20USERID 20

SIGNONSTATUS optionINQUIRE TERMINAL 143, 147

SINGLE optionTRACE 54

SINGLEOFF CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

SINGLEON CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

SINGLESTATUS optionINQUIRE TRACEFLAG 165SET TRACEFLAG 166

SIT optionDUMP 50DUMP TRANSACTION 50

Size fieldCICS_EpiEventData_t 236

Size parameterCICS_EpiReply 235CICS_EpiStartTran 234

SKIP CVDAINQUIRE TDQUEUE 226

SM optionINQUIRE TRACETYPE 167SET TRACETYPE 169

SMF CVDAINQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 188INQUIRE JOURNALNUM 190

SNA CVDAINQUIRE CONNECTION 135

SOS CVDAINQUIRE SYSTEM 174

SOSABOVE CVDAINQUIRE SYSTEM 174

304 API Structure

SOSBELOW CVDAINQUIRE SYSTEM 174

SOSI CVDAINQUIRE TERMINAL 147

SOSI optionASSIGN 62

SOSIST optionINQUIRE TERMINAL 143, 147

SOSSTATUS optionINQUIRE SYSTEM 172, 174

SP optionINQUIRE TRACETYPE 167SET TRACETYPE 169

SPECIAL optionINQUIRE TRACETYPE 167SET TRACETYPE 168

SPECIFIC CVDAINQUIRE CONNECTION 136

SPECTRACE CVDAINQUIRE TASK 215INQUIRE TERMINAL 147INQUIRE TRANSACTION 223SET TERMINAL 149SET TRANSACTION 224

SPI CVDAINQUIRE EXITPROGRAM 178

SPIST optionINQUIRE EXITPROGRAM 177, 178

SPOOLDEST optionINQUIRE TERMINAL 143

SPOOLTO optionINQUIRE TERMINAL 143

SPRSTRACE CVDAINQUIRE TASK 215INQUIRE TRANSACTION 223SET TRANSACTION 224

ST optionINQUIRE TRACETYPE 167SET TRACETYPE 169

STALL optionINQUIRE SYSTEM 172SET SYSTEM 175

STANDARD optionINQUIRE TRACETYPE 167SET TRACETYPE 168

STANTRACE CVDAINQUIRE TASK 215INQUIRE TERMINAL 147INQUIRE TRANSACTION 223SET TERMINAL 149SET TRANSACTION 224

START commandconditions

INVREQ 6, 84IOERR 6, 84ISCINVREQ 6, 84LENGERR 6, 84

START command (continued)conditions (continued)

NOTAUTH 6, 84SYSIDERR 6, 84TERMIDERR 6, 84TRANSIDERR 6, 84USERIDERR 6, 84

optionsAFTER 6, 84AT 6, 84FMH 85FROM 6, 84HOURS 6, 84INTERVAL 6, 84LENGTH 6, 84MINUTES 6, 84NOCHECK 6, 84PROTECT 6, 84QUEUE 6, 84REQID 6, 84RTERMID 6, 84RTRANSID 6, 84SECONDS 6, 84SYSID 6, 84TERMID 6, 84TIME 6, 84TRANSID 6, 84USERID 6, 84

START CVDAINQUIRE REQID 201

STARTBR commandaddressed file standard definition 73BDAM (DAM) file standard definition 78conditions

DISABLED 70, 73, 75, 78FILENOTFOUND 70, 73, 75, 78ILLOGIC 70, 73, 75INVREQ 70, 73, 75, 78IOERR 70, 73, 75, 78ISCINVREQ 70, 73, 75, 78NOTAUTH 70, 73, 75, 78NOTFND 70, 73, 75, 78NOTOPEN 70, 73, 75, 78SYSIDERR 70, 73, 75, 78


DEBKEY 78DEBREC 78EQUAL 70, 75FILE 70, 73, 75, 78GENERIC 70GTEQ 70, 75KEYLENGTH 70, 78RBA 73, 79REQID 70, 73, 75, 78RIDFLD 70, 73, 75, 78

Index 305

STARTBR command (continued)options (continued)

RRN 75SYSID 70, 73, 75, 78

STARTCODE optionASSIGN 62INQUIRE TASK 213

STARTED CVDAINQUIRE EXITPROGRAM 178

STARTING CVDAINQUIRE UOWLINK 207

STARTIO optionJOURNAL 94WAIT JOURNAL 94WAIT JOURNALNUM 93WRITE JOURNALNUM 94

STARTSTATUS optionINQUIRE EXITPROGRAM 177, 178

STARTUP CVDAINQUIRE SYSTEM 173

STARTUP optionINQUIRE SYSTEM 172, 174

STARTUPDATE optionINQUIRE SYSTEM 172

STATE optionALLOCATE 14CONNECT PROCESS 14CONVERSE 14EXTRACT ATTRIBUTES 14FREE 14INQUIRE UOWENQ 206ISSUE ABEND 14ISSUE CONFIRMATION 14ISSUE ERROR 14ISSUE PREPARE 14ISSUE SIGNAL 15RECEIVE 15SEND 15WAIT 15

STATIC CVDAINQUIRE DSNAME 153INQUIRE TASK 215INQUIRE TRANSACTION 222

STATIONID optionASSIGN 62

STATISTICS optionINQUIRE TRACETYPE 167SET TRACETYPE 169

STATUS optionINQUIRE JOURNALNAME 187, 188INQUIRE MONITOR 193INQUIRE PROGRAM 197, 198INQUIRE STREAMNAME 191INQUIRE TRANSACTION 221, 222SET JOURNALNAME 188SET MONITOR 194, 195

STATUS option (continued)SET PROGRAM 199, 200SET TRANSACTION 224

STOPPED CVDAINQUIRE EXITPROGRAM 178

STORAGE optionDUMP 50DUMP TRANSACTION 50INQUIRE TRACETYPE 167SET TRACETYPE 169

STORAGECLEAR optionINQUIRE TASK 213, 215INQUIRE TRANSACTION 221, 222

STOREPROTECT optionINQUIRE SYSTEM 172, 174

STREAMNAME optionINQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 187INQUIRE STREAMNAME 191

STRFIELD optionCONVERSE 116SEND 116

STRINGS optionINQUIRE FILE 179SET FILE 183

SUBORDINATE CVDAINQUIRE UOWLINK 207

SUBSYSTEMID optionINQUIRE MONITOR 193

SUPPRESSED conditionDUMP SYSTEM 52DUMP TRANSACTION 50

SURROGATE CVDAINQUIRE TERMINAL 146

SUSPEND command 108SUSPENDED CVDA

INQUIRE TASK 215SUSPENDED option

INQUIRE TASK LIST 216SUSPENDTIME option

INQUIRE TASK 213SUSPENDTYPE option

INQUIRE TASK 213SUSPENDVALUE option

INQUIRE TASK 213SVA CVDA

INQUIRE PROGRAM 199SVASTATUS option

INQUIRE PROGRAM 197, 199SWITCH CVDA

SET DUMPDS 158SET TRACEDEST 164

SWITCHACTION optionSET TRACEDEST 164

SWITCHALL CVDAINQUIRE TRACEDEST 163

306 API Structure

SWITCHALL CVDA (continued)SET TRACEDEST 164

SWITCHING CVDAINQUIRE TDQUEUE 226

SWITCHNEXT CVDAINQUIRE DUMPDS 157INQUIRE TRACEDEST 163SET DUMPDS 158SET TRACEDEST 164

SWITCHSTATUS optionINQUIRE DUMPDS 157INQUIRE TRACEDEST 163SET DUMPDS 157, 158SET TRACEDEST 164

SYNCLEVEL optionCONNECT PROCESS 14EXTRACT PROCESS 14

SYNCONRETURN optionEXCI LINK 247LINK 99

SYNCPOINT commandconditions

INVREQ 105ROLLEDBACK 105

optionsROLLBACK 105

SYNCPOINT CVDAINQUIRE MONITOR 194SET MONITOR 195

SYNCPOINTST optionINQUIRE MONITOR 193SET MONITOR 194, 195

SYSBUSY conditionALLOCATE 14DUMP SYSTEM 52

SYSDUMP CVDAINQUIRE SYSDUMPCODE 159INQUIRE SYSTEM 173INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET SYSTEM 176SET TRANDUMPCODE 162

SYSDUMPCODE optionINQUIRE SYSDUMPCODE 158SET SYSDUMPCODE 160

SYSDUMPING optionINQUIRE SYSDUMPCODE 158INQUIRE TRANDUMPCODE 161SET SYSDUMPCODE 160SET TRANDUMPCODE 162

SysErr parameterCICS_EpiGetSysError 235

SYSID optionALLOCATE 14ASSIGN 62CANCEL 5, 83, 89

SYSID option (continued)DELETE 68, 71, 73DELETEQ TD 123DELETEQ TS 111ENDBR 69, 74, 77INQUIRE SYSTEM 172INQUIRE TSQUEUE 219INQUIRE UOW 203INQUIRE UOWDSNFAIL 205INQUIRE UOWLINK 207LINK 99READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78START 6, 84STARTBR 70, 73, 75, 78UNLOCK 70, 73, 78WRITE 71, 73, 78WRITEQ TD 124WRITEQ TS 112

SYSIDERR conditionALLOCATE 14CANCEL 5, 83, 89DELETE 68, 71, 73DELETEQ TD 123DELETEQ TS 111ENDBR 69, 71, 74, 77LINK 99READ 69, 71, 74, 77READNEXT 69, 72, 74, 77READPREV 69, 72, 74READQ TD 124READQ TS 112RESETBR 70, 72, 75, 77REWRITE 70, 72, 75, 78START 6, 84STARTBR 70, 73, 75, 78UNLOCK 70, 73, 75, 78WRITE 71, 73, 76, 78WRITEQ TD 124WRITEQ TS 112

SYSLOG CVDAINQUIRE STREAMNAME 191

SYSOUTCLASS optionINQUIRE TDQUEUE 225

system parameterCICS_EpiAddTerminal 234

SYSTEM CVDAINQUIRE TRANSACTION 222SET TRANSACTION 224

SYSTEM optionTRACE 54

Index 307

system parameterCICS_EpiInquireSystem 235

SYSTEM_ERROR return codeDFHXCIS 247, 248

SYSTEMLOG optionINQUIRE STREAMNAME 191

SystemName fieldCICS_EpiSystem_t 236

SYSTEMOFF CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

SYSTEMON CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

systems parameterCICS_EciListSystems 246CICS_EpiListSystems 234

SYSTEMSTATUS optionINQUIRE TRACEFLAG 165SET TRACEFLAG 166

SZ optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TTABLE option

INQUIRE FILE 179, 182SET FILE 183, 184

TABLES optionDUMP 50DUMP TRANSACTION 50

TABLESIZE optionINQUIRE TRACEDEST 163SET TRACEDEST 164

TAKEOVER CVDAINQUIRE SYSTEM 174

TALENGTH optionINQUIRE EXITPROGRAM 177

TAPE1 CVDAINQUIRE JOURNALNUM 190

TAPE2 CVDAINQUIRE JOURNALNUM 190

TASK CVDAINQUIRE TASK 214

TASK optionDEQ 107DUMP 50DUMP TRANSACTION 50ENQ 108INQUIRE STORAGE 211INQUIRE TASK 213SET TASK 216

TASKDATAKEY optionINQUIRE TASK 213, 215INQUIRE TRANSACTION 221, 223

TASKDATALOC optionINQUIRE TASK 213, 215INQUIRE TRANSACTION 221, 223

TASKID optionINQUIRE TERMINAL 143INQUIRE UOW 203INQUIRE UOWENQ 206

TASKPRIORITY optionASSIGN 62

TASKSTART CVDAINQUIRE EXITPROGRAM 178

TASKSTARTST optionINQUIRE EXITPROGRAM 177, 178

TASKTHRESH optionINQUIRE SYSTEM 172

TC optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TCAM CVDAINQUIRE TERMINAL 144

TCAMCONTROL optionINQUIRE TERMINAL 143SET TERMINAL 148

TCAMSNA CVDAINQUIRE TERMINAL 144

TCEXITALL CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

TCEXITALLOFF CVDASET TRACEFLAG 166

TCEXITNONE CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

TCEXITSTATUS optionINQUIRE TRACEFLAG 165SET TRACEFLAG 166

TCEXITSYSTEM CVDAINQUIRE TRACEFLAG 165SET TRACEFLAG 166

TCLASS optionINQUIRE TASK 213INQUIRE TCLASS 217INQUIRE TRANSACTION 221SET TCLASS 217SET TRANSACTION 224

TCPIP CVDAINQUIRE CONNECTION 135

TCT optionDUMP 50DUMP TRANSACTION 50

TCTUA optionADDRESS 58

TCTUALENG optionASSIGN 62

TD optionINQUIRE TRACETYPE 167

308 API Structure

TD option (continued)SET TRACETYPE 169

TDQUEUE CVDAINQUIRE UOWENQ 206

TDQUEUE optionINQUIRE TDQUEUE 225SET TDQUEUE 228

TELLERID optionASSIGN 62

TERM CVDAINQUIRE TASK 214

TERMCODE optionASSIGN 62

TERMERR conditionCONVERSE 14, 116ISSUE ABEND 14ISSUE CONFIRMATION 14ISSUE COPY 118ISSUE ERASEAUP 118ISSUE ERROR 14ISSUE PREPARE 14ISSUE PRINT 118ISSUE SIGNAL 15LINK 99RECEIVE 15, 116SEND 15, 116

TERMID optionINQUIRE REQID 201INQUIRE UOW 203ISSUE COPY 118START 6, 84

TERMIDERR conditionSTART 6, 84

TERMINAL CVDAINQUIRE TDQUEUE 226INQUIRE TERMINAL 146SET TDQUEUE 228

TERMINAL optionDUMP 50DUMP TRANSACTION 50INQUIRE TERMINAL 141RECEIVE MAP 29SEND CONTROL 36SEND MAP 36SEND TEXT 37SEND TEXT MAPPED 37SET TERMINAL 148

TermIndex fieldCICS_EpiEventData_t 236

TermIndex parameterCICS_EpiAddTerminal 234CICS_EpiATIState 235CICS_EpiDelTerminal 234CICS_EpiGetEvent 235CICS_EpiGetSysError 235CICS_EpiInquireSystem 235

TermIndex parameter (continued)CICS_EpiReply 235CICS_EpiSenseCode 235CICS_EpiStartTran 234

TERMMODEL optionINQUIRE TERMINAL 143

Termname fieldCICS_EpiDetails_t 236

TERMPRIORITY optionASSIGN 62INQUIRE TERMINAL 143SET TERMINAL 148

TERMSTATUS optionINQUIRE TERMINAL 143, 147SET TERMINAL 148, 149

TEXTKYBD CVDAINQUIRE TERMINAL 147

TEXTKYBD optionASSIGN 63

TEXTKYBDST optionINQUIRE TERMINAL 143, 147

TEXTPRINT CVDAINQUIRE TERMINAL 147

TEXTPRINT optionASSIGN 63

TEXTPRINTST optionINQUIRE TERMINAL 143, 147

THIRDINIT CVDAINQUIRE SYSTEM 173

TI optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TIME optionDELAY 90FORMATTIME 88INQUIRE MONITOR 193, 194INQUIRE REQID 201INQUIRE SYSTEM 172INQUIRE VOLUME 229POST 90ROUTE 39SET SYSTEM 175START 6, 84

TIMER optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TIMESEP optionFORMATTIME 88

TITLE optionDUMP SYSTEM 52ROUTE 39

TITLELENGTH optionDUMP SYSTEM 52

TOFLENGTH optionCONVERSE 14, 116

Index 309

TOKEN optionDELETE 80READ 80READNEXT 81READPREV 81REWRITE 80UNLOCK 80

TOLENGTH optionCONVERSE 14, 116

TPNAME optionINQUIRE PARTNER 151

TPNAMELEN optionINQUIRE PARTNER 151

TR optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TRACE commandoptions

EI 54OFF 54ON 54SINGLE 54SYSTEM 54USER 54

TRACE optionINQUIRE TRACETYPE 167SET TRACETYPE 169

TRACING optionINQUIRE TASK 213, 215INQUIRE TERMINAL 143, 147INQUIRE TRANSACTION 221, 223SET TERMINAL 148, 149SET TRANSACTION 224

TRAILER optionSEND PAGE 36

TRAILER optionSEND TEXT 37

TRANCLASS optionINQUIRE TASK 213INQUIRE TRANCLASS 217INQUIRE TRANSACTION 221SET TRANCLASS 218SET TRANSACTION 224

TRANDUMP CVDAINQUIRE TASK 214INQUIRE TRANDUMPCODE 161INQUIRE TRANSACTION 222SET TRANDUMPCODE 162SET TRANSACTION 224

TRANDUMPCODE optionINQUIRE TRANDUMPCODE 161SET TRANDUMPCODE 162

TRANDUMPING optionINQUIRE TRANDUMPCODE 161SET TRANDUMPCODE 162

TRANIDONLY CVDAINQUIRE TERMINAL 147SET TERMINAL 150

TRANISOLATE optionINQUIRE SYSTEM 172, 174

TRANMGR optionINQUIRE TRACETYPE 168SET TRACETYPE 169

TRANPRIORITY optionASSIGN 63INQUIRE TASK 213

TRANSACTION optionINQUIRE TASK 213INQUIRE TERMINAL 143INQUIRE TRANSACTION 221SET TRANSACTION 223

TransId fieldCICS_EpiEventData_t 236

TRANSID optionCANCEL 5, 83, 89EXCI LINK 247INQUIRE PROGRAM 197INQUIRE REQID 201INQUIRE TSQUEUE 219INQUIRE UOW 203INQUIRE UOWENQ 206LINK 99RETURN 100SEND PAGE 40START 6, 84

TransId parameterCICS_EpiStartTran 234DPL 248

TRANSIDERR conditionSTART 6, 84

TRIGGER optionHANDLE AID 119

TRIGGERLEVEL optionINQUIRE TDQUEUE 225SET TDQUEUE 228

TRPROF optionINQUIRE TASK 214INQUIRE TRANSACTION 221

TRT optionDUMP TRANSACTION 50

TS optionINQUIRE TRACETYPE 168SET TRACETYPE 169

TSIOERR conditionPURGE MESSAGE 37SEND CONTROL 37, 39SEND MAP 37, 39SEND PAGE 38SEND TEXT 38, 39SEND TEXT MAPPED 38, 39SEND TEXT NOEDIT 38, 39

310 API Structure

TSQUEUE CVDAINQUIRE UOWENQ 206

TSQUEUE optionINQUIRE TSQUEUE 219

TTI CVDAINQUIRE TERMINAL 147SET TERMINAL 150

TTISTATUS optionINQUIRE TERMINAL 143, 147SET TERMINAL 148, 150

TWA optionADDRESS 58

TWALENG optionASSIGN 63

TWASIZE optionINQUIRE TASK 214INQUIRE TRANSACTION 221

TYPE optionINQUIRE FILE 179, 182INQUIRE JOURNALMODEL 187INQUIRE JOURNALNAME 187, 188INQUIRE TDQUEUE 225, 227INQUIRE UOWENQ 206INQUIRE UOWLINK 207

UUCTRAN CVDA


UCTRANST optionINQUIRE TERMINAL 143, 147SET TERMINAL 148, 150

UDSASIZE optionINQUIRE SYSTEM 172

UE optionINQUIRE TRACETYPE 168SET TRACETYPE 169

UNATTEND optionASSIGN 63

UNAVAILABLE CVDAINQUIRE UOWLINK 207INQUIRE VTAM 132SET DSNAME 155

UNBLOCKED CVDAINQUIRE FILE 180INQUIRE TDQUEUE 226

UNCOMMITTED CVDAINQUIRE FILE 181SET FILE 184

UNCOMMITTED optionREAD 80READNEXT 80READPREV 80

UNCONNECTED CVDAINQUIRE UOWLINK 207

UNDEFINED CVDAINQUIRE FILE 181INQUIRE TDQUEUE 227INQUIRE UOWDSNFAIL 205

UNDETERMINED CVDAINQUIRE DSNAME 153, 154

UNENABLED CVDAINQUIRE FILE 180

UNENABLING CVDAINQUIRE FILE 181

UNEXPIN conditionRECEIVE MAP 35

UNKNOWN CVDAINQUIRE EXITPROGRAM 177INQUIRE UOWLINK 207

UNLOCK commandaddressed file standard definition 73BDAM (DAM) file standard definition 78conditions

DISABLED 70, 73, 75, 78FILENOTFOUND 70, 73, 75, 78ILLOGIC 70, 73, 75INVREQ 80IOERR 70, 73, 75, 78ISCINVREQ 70, 73, 75, 78NOTAUTH 73, 75, 78NOTOPEN 70, 73, 75, 78SYSIDERR 70, 73, 75, 78


FILE 70, 73, 75, 78SYSID 70, 73, 75, 78TOKEN 80

UNQUIESCED CVDAINQUIRE DSNAME 154SET DSNAME 155

UNREGISTERED CVDAINQUIRE VTAM 132

UNTIL optionDELAY 90

UOW optionINQUIRE TASK 214INQUIRE UOW 203INQUIRE UOWDSNFAIL 205INQUIRE UOWENQ 206INQUIRE UOWLINK 207SET UOW 204

UOWACTION optionSET CONNECTION 137, 138SET DSNAME 155

uowid parameterDPL 248

UOWLINK optionINQUIRE UOWLINK 207SET UOWLINK 208

Index 311

UOWSTATE optionINQUIRE TASK 214, 215INQUIRE UOW 203SET UOW 204

UPDATABLE CVDAINQUIRE FILE 182SET FILE 185

UPDATE optionINQUIRE FILE 179, 182QUERY SECURITY 23READ 69, 71, 74, 77READNEXT 81READPREV 81SET FILE 183, 184

US optionINQUIRE TRACETYPE 168SET TRACETYPE 169

USCS optionINQUIRE SYSTEM 172SET SYSTEM 175

USECOUNT optionINQUIRE PROGRAM 197INQUIRE STREAMNAME 191

USER CVDAINQUIRE TRANSACTION 222SET TRANSACTION 224

USER optionINQUIRE TRACETYPE 168TRACE 54

USER_ERROR return codeDFHXCIS 247, 248

user_name parameterInitialise_User 247

user_token parameterAllocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Initialise_User 247Open_Pipe 248

USERAREA optionINQUIRE TERMINAL 143

USERAREALEN optionINQUIRE TERMINAL 143

USERDATAKEY CVDAINQUIRE TASK 215INQUIRE TRANSACTION 223

USERDATAKEY optionGETMAIN 104

USEREXECKEY CVDAINQUIRE PROGRAM 198

USERID optionASSIGN 63CHANGE PASSWORD 24INQUIRE REQID 201INQUIRE TASK 214

USERID option (continued)INQUIRE TERMINAL 143INQUIRE UOW 203SIGNON 20START 6, 84VERIFY PASSWORD 25

userid parameterDPL 248

USERIDERR conditionCHANGE PASSWORD 24SIGNON 20START 6, 84VERIFY PASSWORD 25

USERNAME optionASSIGN 63INQUIRE TERMINAL 143

USEROFF CVDAINQUIRE TRACEDEST 163INQUIRE TRACEFLAG 165SET TRACEDEST 164SET TRACEFLAG 166

USERON CVDAINQUIRE TRACEDEST 163INQUIRE TRACEFLAG 165SET TRACEDEST 164SET TRACEFLAG 166

USERPRIORITY optionASSIGN 63

USERSTATUS optionINQUIRE TRACEDEST 163INQUIRE TRACEFLAG 165SET TRACEDEST 164SET TRACEFLAG 166

USERTABLE CVDAINQUIRE FILE 182SET FILE 184

USING optionADDRESS 60

VVALID CVDA

INQUIRE DSNAME 154VALIDATION CVDA

INQUIRE TERMINAL 147VALIDATION option

ASSIGN 63VALIDATIONST option

INQUIRE TERMINAL 143, 147VALIDITY option

INQUIRE DSNAME 153, 154Value field

CICS_EpiSysError_t 237VARIABLE CVDA

INQUIRE FILE 181INQUIRE TDQUEUE 227

312 API Structure

VERIFY PASSWORD commandconditions

INVREQ 25NOTAUTH 25USERIDERR 25

optionsCHANGETIME 25DAYSLEFT 25ESMREASON 25ESMRESP 25EXPIRYTIME 25INVALIDCOUNT 25LASTUSETIME 25PASSWORD 25USERID 25

VERSION optionSET PROGRAM 199, 200

version parameterCICS_EpiInitialize 234

version_number parameterAllocate_Pipe 247Close_Pipe 248Deallocate_Pipe 248DPL 248Initialise_User 247Open_Pipe 248

VFORM CVDAINQUIRE TERMINAL 147

VFORMST optionINQUIRE TERMINAL 143, 147

VOLUME optionINQUIRE VOLUME 229SET VOLUME 230

VRRDS CVDAINQUIRE FILE 182

VSAM CVDAINQUIRE DSNAME 153INQUIRE FILE 180

VSAM filesaddressed data sets (ESDS) support 71keyed data sets (KSDS) support 68numbered data set (RRDS) support 73

VTAM CVDAINQUIRE CONNECTION 135INQUIRE TERMINAL 144

WWAIT command

conditionsINVREQ 15NOTALLOC 15


WAIT CVDAINQUIRE EXITPROGRAM 177INQUIRE TASK 214INQUIRE TDQUEUE 226INQUIRE TRANSACTION 222SET DSNAME 155SET FILE 184

WAIT EVENT commandconditions

INVREQ 90options

ECADDR 90NAME 91

WAIT EXTERNAL commandconditions

INVREQ 109options

ECBLIST 109NAME 109NOTPURGEABLE 109NUMEVENTS 109PURGEABILITY 109PURGEABLE 109

WAIT JOURNAL commandconditions

INVREQ 94IOERR 94JIDERR 94NOTOPEN 94

optionsJFILEID 94REQID 94STARTIO 94

WAIT JOURNALNAME commandconditions


optionsREQID 95

WAIT JOURNALNUM commandconditions


optionsREQID 93STARTIO 93

WAIT optionISSUE COPY 118ISSUE ERASEAUP 118JOURNAL 94RETRIEVE 5, 84SEND 15, 116

Index 313

WAIT option (continued)SEND CONTROL 29SEND MAP 30SEND TEXT 30SEND TEXT MAPPED 34SEND TEXT NOEDIT 34WRITE JOURNALNAME 95WRITE JOURNALNUM 94

Wait parameterCICS_EpiGetEvent 235

WAITCAUSE optionINQUIRE UOW 203

WAITCICS commandconditions

INVREQ 109options

ECBLIST 109NAME 109NOTPURGEABLE 109NUMEVENTS 109PURGEABILITY 109PURGEABLE 109

WAITCOMMIT CVDAINQUIRE UOW 203

WAITER CVDAINQUIRE UOWENQ 206

WAITFORGET CVDAINQUIRE TASK 215INQUIRE UOW 203

WAITING CVDAINQUIRE UOW 204

WAITRMI CVDAINQUIRE UOW 203

WAITSTATE optionINQUIRE UOW 203

WARMSTART CVDAINQUIRE SYSTEM 174INQUIRE UOWLINK 207

WARNINGDFHXCIS 247, 248

WRBRK conditionSEND CONTROL 29, 33SEND MAP 33SEND TEXT 34SEND TEXT MAPPED 34SEND TEXT NOEDIT 34

WRITE commandaddressed file standard definition 73BDAM (DAM) file standard definition 78conditions

DISABLED 71, 73, 76, 78DUPREC 71, 76, 78FILENOTFOUND 71, 73, 76, 78ILLOGIC 71, 73, 76INVREQ 71, 73, 76, 78IOERR 71, 73, 76, 78ISCINVREQ 71, 73, 76, 78

WRITE command (continued)conditions (continued)

LENGERR 71, 73, 76, 78LOCKED 80NOSPACE 71, 73, 76, 78NOTAUTH 71, 73, 76, 78NOTFND 78NOTOPEN 71, 73, 76, 78RECORDBUSY 80SYSIDERR 71, 73, 76, 78


FILE 71, 73, 76, 78FROM 71, 73, 76, 78KEYLENGTH 71, 78LENGTH 71, 73, 76, 78MASSINSERT 71, 73, 76NOSUSPEND 80RBA 73, 79RIDFLD 71, 73, 76, 78RRN 76SYSID 71, 73, 76, 78

WRITE JOURNALNAME commandconditions

INVREQ 95IOERR 95JIDERR 95LENGERR 95NOJBUFSP 95NOTAUTH 95NOTOPEN 95

optionsFLENGTH 95FROM 95JTYPEID 95NOSUSPEND 95PFXLENG 95PREFIX 95REQID 95WAIT 95

WRITE JOURNALNUM commandconditions

IOERR 94JIDERR 94LENGERR 94NOJBUFSP 94NOTAUTH 94NOTOPEN 94

optionsFROM 94JTYPEID 94LENGTH 94NOSUSPEND 94PFXLENG 94PREFIX 94REQID 94

314 API Structure

WRITE JOURNALNUM command (continued)options (continued)

STARTIO 94WAIT 94

WRITEQ TD commandconditions

DISABLED 124INVREQ 124IOERR 124ISCINVREQ 124LENGERR 124LOCKED 125NOSPACE 124NOTAUTH 124NOTOPEN 124QIDERR 124SYSIDERR 124

optionsFROM 124LENGTH 124QUEUE 124SYSID 124

WRITEQ TS commandconditions

INVREQ 112IOERR 112ITEMERR 112LENGERR 112LOCKED 113NOSPACE 112NOTAUTH 112QIDERR 112SYSIDERR 112

optionsAUXILIARY 112FROM 112ITEM 112LENGTH 112MAIN 112NOSUSPEND 112NUMITEMS 112QUEUE 112REWRITE 112SYSID 112

XXCF CVDA

INQUIRE CONNECTION 136XCTL command

conditionsLENGERR 100NOTAUTH 100PGMIDERR 100

optionsCOMMAREA 100INPUTMSG 100

XCTL command (continued)options (continued)

INPUTMSGLEN 100LENGTH 100PROGRAM 100

XLNSTATUS optionINQUIRE CONNECTION 135, 136

XM CVDAINQUIRE CONNECTION 136

XM optionINQUIRE TRACETYPE 168SET TRACETYPE 169

XNOTDONE CVDAINQUIRE CONNECTION 137

XOK CVDAINQUIRE CONNECTION 137

XRFSTATUS optionINQUIRE SYSTEM 172, 174

XS optionINQUIRE TRACETYPE 168SET TRACETYPE 169

YYEAR option

FORMATTIME 88YYDDD option

FORMATTIME 88YYDDMM option

FORMATTIME 88YYMMDD option

FORMATTIME 88YYYYDDD option

FORMATTIME 88YYYYDDMM option

FORMATTIME 88YYYYMMDD option

FORMATTIME 88

ZZCPTRACE CVDA

INQUIRE CONNECTION 137INQUIRE TERMINAL 147SET CONNECTION 138SET TERMINAL 150

ZCPTRACING optionINQUIRE CONNECTION 135, 137INQUIRE TERMINAL 143, 147SET CONNECTION 137, 138SET TERMINAL 148, 150

Index 315

Sending your comments to IBMCICS Family

API Structure

SC33-1007-02

If you especially like or dislike anything about this book, please use one of the methodslisted below to send your comments to IBM.

Feel free to comment on what you regard as specific errors or omissions, and on theaccuracy, organization, subject matter, or completeness of this book. Please limit yourcomments to the information in this book and the way in which the information ispresented.

To request additional publications, or to ask questions or make comments about thefunctions of IBM products or systems, you should talk to your IBM representative or toyour IBM authorized remarketer.

When you send comments to IBM, you grant IBM a nonexclusive right to use ordistribute your comments in any way it believes appropriate, without incurring anyobligation to you.

You can send your comments to IBM in any of the following ways:

� By mail, use the Readers’ Comment Form (RCF)

� By fax:

– From outside the U.K., after your international access code use 44 1962 870229– From within the U.K., use 01962 870229

� Electronically, use the appropriate network ID:

– IBM Mail Exchange: GBIBM2Q9 at IBMMAIL – IBMLink: WINVMD(IDRCF) – Internet: [email protected]

Whichever you use, ensure that you include:

� The publication number and title� The page number or topic to which your comment applies� Your name/address/telephone number/fax number/network ID.

Readers’ CommentsCICS Family API Structure

SC33-1007-02

Use this form to tell us what you think about this manual. If you have found errors in it,or if you want to express your opinion about it (such as organization, subject matter,appearance) or make suggestions for improvement, this is the form to use.

To request additional publications, or to ask questions or make comments about thefunctions of IBM products or systems, you should talk to your IBM representative or toyour IBM authorized remarketer. This form is provided for comments about theinformation in this manual and the way it is presented.

When you send comments to IBM, you grant IBM a nonexclusive right to use ordistribute your comments in any way it believes appropriate without incurring anyobligation to you.

Be sure to print your name and address below if you would like a reply.

Name Address

Company or Organization

Telephone Email

CICS FamilyAPI Structure SC33-1007-02 IBM

NameFrom:

Fold along this line

Fasten here with adhesive tape

Cut along this line

Address

EMAIL

Company or Organization

Telephone

NE PAS AFFRANCHIR

NO STAMP REQUIRED

PHQ - D/1348/SOIBRS/CCRI NUMBER:

REPONSE PAYEEGRANDE-BRETAGNE

IBM United Kingdom LaboratoriesInformation Development Department (MP095)Hursley Park,WINCHESTER, HantsSO21 2ZZ United Kingdom

By air mailPar avion

Fold along this line

Cut along this line

IBM

Printed in U.S.A.

SC33-1++7-+2

cics family api structure - support - ibm

Documents