CICS API Reference

This document details the level of CICS API support in Mainframe Express 3.1 WebSync 10.

Micro Focus, the Micro Focus Logo, and Mainframe Express are trademarks or registered trademarks of Micro Focus IP Development Limited in the United Kingdom, the United States and other countries.

All other marks are the property of their respective owners.

API

ABEND
ADDRESS
ADDRESS SET
ALLOCATE
ASKTIME
ASSIGN
BIF DEEDIT
BUILD ATTACH
CANCEL
CHANGE PASSWORD
CHANGE TASK
CONNECT PROCESS
CONVERSE
DEFINE COUNTER
DEFINE DCOUNTER
DELAY
DELETE
DELETE CONTAINER
DELETE COUNTER
DELETE DCOUNTER
DELETE RIDFLD
DELETEQ
DELETEQ TD
DELETEQ TS
DEQ
DOCUMENT CREATE
DOCUMENT INSERT
DOCUMENT RETRIEVE
DOCUMENT SET
DUMP
DUMP SYSTEM
DUMP TRANSACTION
ENDBR
ENDBROWSE ACTIVITY
ENDBROWSE CONTAINER
ENDBROWSE EVENT
ENDBROWSE PROCESS
ENQ
ENTER TRACEID
ENTER TRACENUM
FEPI
FORMATTIME
FREE
FREEMAIN
GDS ALLOCATE
GDS ASSIGN
GDS CONNECT PROCESS
GDS EXTRACT ATTRIBUTES
GDS EXTRACT PROCESS
GDS FREE
GDS ISSUE ABEND
GDS ISSUE CONFIRMATION
GDS ISSUE ERROR
GDS ISSUE PREPARE
GDS ISSUE SIGNAL
GDS RECEIVE
GDS SEND
GDS WAIT
GET CONTAINER
GET COUNTER
GET DCOUNTER
GETMAIN
GETNEXT ACTIVITY
GETNEXT CONTAINER
GETNEXT EVENT
GETNEXT PROCESS
HANDLE ABEND
HANDLE AID
HANDLE CONDITION
IGNORE CONDITION
INVOKE WEBSERVICE
ISSUE ABEND
ISSUE ABORT
ISSUE ADD
ISSUE CONFIRMATION
ISSUE COPY
ISSUE DISCONNECT
ISSUE END
ISSUE ENDFILE
ISSUE ENDOUTPUT
ISSUE EODS
ISSUE ERASE
ISSUE ERASEAUP
ISSUE ERROR
ISSUE LOAD
ISSUE NOTE
ISSUE PASS
ISSUE PREPARE
ISSUE PRINT
ISSUE QUERY
ISSUE RECEIVE
ISSUE REPLACE
ISSUE RESET
ISSUE SEND
ISSUE SIGNAL
ISSUE WAIT
JOURNAL
LINK
LOAD
MONITOR
MOVE CONTAINER
POINT
POP
POP HANDLE
POST
PURGE MESSAGE
PUSH
PUSH HANDLE
PUT CONTAINER
QUERY COUNTER
QUERY DCOUNTER
QUERY SECURITY
READ
READNEXT
READPREV
READQ
READQ TD
READQ TS
RECEIVE
RECEIVE MAP
RECEIVE MAP MAPPINGDEV
RECEIVE MAPSET
RECEIVE PARTN
RELEASE
RESETBR
RETRIEVE
RETURN
REWIND COUNTER
REWIND DCOUNTER
REWRITE
ROUTE
SEND
SEND CONTROL
SEND MAP
SEND MAP MAPPINGDEV
SEND MAPSET
SEND PAGE
SEND PARTNSET
SEND TEXT
SEND TEXT MAPPED
SEND TEXT NOEDIT
SIGNOFF
SIGNON
SPOOLCLOSE
SPOOLCLOSE REPORT
SPOOLOPEN ESCAPE
SPOOLOPEN INPUT
SPOOLOPEN MAPNAME
SPOOLOPEN OUTPUT
SPOOLOPEN REPORT ASA
SPOOLOPEN REPORT JCL
SPOOLOPEN REPORT MCC
SPOOLOPEN REPORT NOCC
SPOOLOPEN REPORT SCS
SPOOLOPEN REPORT T3270
SPOOLOPEN RESUME
SPOOLREAD
SPOOLWRITE
SPOOLWRITE MAPNAME
SPOOLWRITE REPORT
START
START ATTACH
START BREXIT
START CHANNEL
STARTBR
STARTBROWSE ACTIVITY
STARTBROWSE CONTAINER
STARTBROWSE EVENT
STARTBROWSE PROCESS
SUSPEND
SYNCPOINT
TRACE
UNLOCK
UPDATE COUNTER
UPDATE DCOUNTER
VERIFY PASSWORD
WAIT CONVID
WAIT EVENT
WAIT EXTERNAL
WAIT JOURNAL
WAIT JOURNALNAME
WAIT JOURNALNUM
WAIT SIGNAL
WAIT TERMINAL
WAITCICS
WEB CLOSE
WEB CONVERSE
WEB ENDBROWSE FORMFIELD
WEB ENDBROWSE HTTPHEADER
WEB EXTRACT
WEB EXTRACT SESSTOKEN
WEB OPEN
WEB PARSE
WEB READ FORMFIELD
WEB READ HTTPHEADER
WEB READNEXT FORMFIELD
WEB READNEXT HTTPHEADER
WEB RECEIVE
WEB RECEIVE SESSTOKEN
WEB RETRIEVE
WEB SEND
WEB SEND SESSTOKEN
WEB STARTBROWSE FORMFIELD
WEB STARTBROWSE HTTPHEADER
WEB WRITE
WRITE
WRITE JOURNALNAME
WRITE JOURNALNUM
WRITE OPERATOR
WRITEQ
WRITEQ TD
WRITEQ TS
XCTL

SPI

ACQUIRE TERMINAL
COLLECT STATISTICS
CREATE CONNECTION
CREATE CORBASERVER
CREATE DB2CONN
CREATE DB2ENTRY
CREATE DB2TRAN
CREATE DJAR
CREATE DOCTEMPLATE
CREATE ENQMODEL
CREATE FILE
CREATE JOURNALMODEL
CREATE LSRPOOL
CREATE MAPSET
CREATE PARTITIONSET
CREATE PARTNER
CREATE PROCESSTYPE
CREATE PROFILE
CREATE PROGRAM
CREATE REQUESTMODEL
CREATE SESSIONS
CREATE TCPIPSERVICE
CREATE TDQUEUE
CREATE TERMINAL
CREATE TRANCLASS
CREATE TRANSACTION
CREATE TSMODEL
CREATE TYPETERM
DISABLE PROGRAM
DISCARD AUTINSTMODEL
DISCARD CONNECTION
DISCARD CORBASERVER
DISCARD DB2CONN
DISCARD DB2ENTRY
DISCARD DB2TRAN
DISCARD DJAR
DISCARD DOCTEMPLATE
DISCARD ENQMODEL
DISCARD FILE
DISCARD JOURNALMODEL
DISCARD JOURNALNAME
DISCARD PARTNER
DISCARD PROCESSTYPE
DISCARD PROFILE
DISCARD PROGRAM
DISCARD REQUESTMODEL
DISCARD TCPIPSERVICE
DISCARD TDQUEUE
DISCARD TERMINAL
DISCARD TRANCLASS
DISCARD TRANSACTION
DISCARD TSMODEL
ENABLE PROGRAM
EXTRACT ATTACH
EXTRACT ATTRIBUTES
EXTRACT CERTIFICATE
EXTRACT EXIT
EXTRACT LOGONMSG
EXTRACT PROCESS
EXTRACT TCPIP
EXTRACT TCT
EXTRACT WEB
INQUIRE AUTINSTMODEL
INQUIRE AUTOINSTALL
INQUIRE BEAN
INQUIRE BRFACILITY
INQUIRE CFDTPOOL
INQUIRE CONNECTION
INQUIRE CORBASERVER
INQUIRE DATASET
INQUIRE DB2CONN
INQUIRE DB2ENTRY
INQUIRE DB2TRAN
INQUIRE DELETSHIPPED
INQUIRE DISPATCHER
INQUIRE DJAR
INQUIRE DOCTEMPLATE
INQUIRE DSNAME
INQUIRE DUMPDS
INQUIRE ENQ
INQUIRE ENQMODEL
INQUIRE EXCI
INQUIRE EXITPROGRAM
INQUIRE FILE
INQUIRE IRC
INQUIRE JOURNALMODEL
INQUIRE JOURNALNAME
INQUIRE JOURNALNUM
INQUIRE JVMPOOL
INQUIRE MODENAME
INQUIRE MONITOR
INQUIRE NETNAME
INQUIRE PARTNER
INQUIRE PROCESSTYPE
INQUIRE PROFILE
INQUIRE PROGRAM
INQUIRE REQID
INQUIRE REQUESTMODEL
INQUIRE RRMS
INQUIRE STATISTICS
INQUIRE STORAGE
INQUIRE STREAMNAME
INQUIRE SYSDUMPCODE
INQUIRE SYSTEM
INQUIRE TASK
INQUIRE TASK LIST
INQUIRE TCLASS
INQUIRE TCPIP
INQUIRE TCPIPSERVICE
INQUIRE TDQUEUE
INQUIRE TERMINAL
INQUIRE TRACEDEST
INQUIRE TRACEFLAG
INQUIRE TRACETYPE
INQUIRE TRANCLASS
INQUIRE TRANDUMPCODE
INQUIRE TRANSACTION
INQUIRE TSMODEL
INQUIRE TSPOOL
INQUIRE TSQNAME
INQUIRE TSQUEUE
INQUIRE UOW
INQUIRE UOWDSNFAIL
INQUIRE UOWENQ
INQUIRE UOWLINK
INQUIRE URIMAP
INQUIRE VOLUME
INQUIRE VTAM
INQUIRE WEB
PERFORM CORBASERVER
PERFORM DELETSHIPPED
PERFORM DJAR
PERFORM DUMP
PERFORM ENDAFFINITY
PERFORM RESETTIME
PERFORM SECURITY REBUILD
PERFORM SHUTDOWN
PERFORM STATISTICS RECORD
RESYNC ENTRYNAME
SET AUTOINSTALL
SET BRFACILITY
SET CONNECTION
SET CORBASERVER
SET DATASET
SET DB2CONN
SET DB2ENTRY
SET DB2TRAN
SET DELETSHIPPED
SET DISPATCHER
SET DSNAME
SET DUMPDS
SET ENQMODEL
SET FILE
SET IRC
SET JOURNALNAME
SET JOURNALNUM
SET JVMPOOL
SET MODENAME
SET MONITOR
SET NETNAME
SET PROCESSTYPE
SET PROGRAM
SET STATISTICS
SET SYSDUMPCODE
SET SYSTEM
SET TASK
SET TCLASS
SET TCPIP
SET TCPIPSERVICE
SET TDQUEUE
SET TERMINAL
SET TRACEDEST
SET TRACEFLAG
SET TRACETYPE
SET TRANCLASS
SET TRANDUMPCODE
SET TRANSACTION
SET TSQNAME
SET TSQUEUE
SET UOW
SET UOWLINK
SET URIMAP
SET VOLUME
SET VTAM
SET WEB

ABEND

The ABEND function is supported.

Operand / Support
ABCODE(data-value) / Full
CANCEL / Full
NODUMP / Full

ACQUIRE TERMINAL

The ACQUIRE TERMINAL function is not supported.

ADDRESS

The ADDRESS function is supported.

Operand / Support
ACEE(ptr-ref) / Full
COMMAREA(ptr-ref) / Full
CSA(ptr-ref) / Full
CWA(ptr-ref) / Full
EIB(ptr-ref) / Full
TCTUA(ptr-ref) / Full
TWA(ptr-ref) / Full

ADDRESS SET

The ADDRESS SET function is supported.

Operand / Support
SET(ptr-ref) / Full
USING(ptr-ref) / Full

ALLOCATE

The ALLOCATE function is supported.

Operand / Support
NOQUEUE / Full
NOSUSPEND / Full
PARTNER(data-value) / Validated
PROFILE(data-value) / Validated
SESSION(data-value) / Validated
STATE(cvda) / Full
SYSID(data-value) / Full

ASKTIME

The ASKTIME function is supported.

Operand / Support
ABSTIME(data-area) / Full

ASSIGN

The ASSIGN function is supported.

Operand / Support
ABCODE(data-area) / Partial: returns x"00" meaning "No dump has been produced"
ABDUMP(data-area) / Partial: returns x"00" meaning "No dump has been produced"
ABPROGRAM(data-area) / Partial: returns x"00" meaning "Indeterminable"
ACTIVITY(data-area) / Validated
ACTIVITYID(data-area) / Validated
ALTSCRNHT(data-area) / Full
ALTSCRNWD(data-area) / Full
APLKYBD(data-area) / Partial: returns x"00" meaning "No"
APLTEXT(data-area) / Partial: returns x"00" meaning "No"
APPLID(data-area) / Full
ASRAINTRPT(data-area) / Partial: returns x"00"
ASRAKEY(data-area) / Validated
ASRAPSW(data-area) / Partial: returns x"00"
ASRAREGS(data-area) / Partial: returns x"00"
ASRASPC(data-area) / Validated
ASRASTG(data-area) / Validated
BRIDGE(data-area) / Full
BTRANS(data-area) / Partial: returns x"00" meaning "No"
CHANNEL(data-area) / Full
CMDSEC(data-area) / Partial: returns Blank meaning "No"
COLOR(data-area) / Full
CWALENG(data-area) / Full
DEFSCRNHT(data-area) / Full
DEFSCRNWD(data-area) / Full
DELIMITER(data-area) / Partial: returns x"00"
DESTCOUNT(data-area) / Partial: returns x"0000"
DESTID(data-area) / Partial: INVREQ occurs
DESTIDLENG(data-area) / Partial: INVREQ occurs
DS3270(data-area) / Partial: returns x"00" meaning "No"
DSSCS(data-area) / Partial: returns x"00" meaning "No"
EWASUPP(data-area) / Full
EXTDS(data-area) / Full
FACILITY(data-area) / Full
FCI(data-area) / Full
GCHARS(data-area) / Full
GCODES(data-area) / Full
GMMI(data-area) / Full
HILIGHT(data-area) / Full
INITPARM(ptr-ref) / Partial: returns x"00" meaning "No parameters"
INITPARMLEN(data-area) / Partial: returns x"00" meaning "No parameter"
INPARTN(data-area) / Partial: returns spaces
INVOKINGPROG(data-area) / Full
KATAKANA(data-area) / Partial: returns x"00" meaning "No"
LANGINUSE(data-area) / Validated
LDCMNEM(data-area) / Partial: returns x"00"
LDCNUM(data-area) / Partial: returns x"00"
MAPCOLUMN(data-area) / Full
MAPHEIGHT(data-area) / Full
MAPLINE(data-area) / Full
MAPWIDTH(data-area) / Full
MSRCONTROL(data-area) / Partial: returns x"00" meaning "No"
NATLANGINUSE(data-area) / Partial: returns "E" meaning "English (US)"
NETNAME(data-area) / Full
NEXTTRANSID(data-area) / Full
NUMTAB(data-area) / Partial: returns x"00"
OPCLASS(data-area) / Full
OPERKEYS(data-area) / Full
OPID(data-area) / Full
OPSECURITY(data-area) / Full
ORGABCODE(data-area) / Full
OUTLINE(data-area) / Full
PAGENUM(data-area) / Full
PARTNPAGE(data-area) / Partial: returns spaces
PARTNS(data-area) / Partial: returns x"00" meaning "No"
PARTNSET(data-area) / Partial: returns spaces meaning "No application partition set"
PRINSYSID(data-area) / Full
PROCESS(data-area) / Validated
PROCESSTYPE(data-area) / Validated
PROGRAM(data-area) / Full
PS(data-area) / Full
QNAME(data-area) / Full
RESSEC(data-area) / Full
RESTART(data-area) / Partial: returns x"00" meaning "Normal Start"
RETURNPROG(data-area) / Full
SCRNHT(data-area) / Full
SCRNWD(data-area) / Full
SIGDATA(data-area) / Partial: returns spaces
SOSI(data-area) / Full
STARTCODE(data-area) / Full
STATIONID(data-area) / Partial: returns x"00"
SYSID(data-area) / Full
TASKPRIORITY(data-area) / Full
TCTUALENG(data-area) / Full
TELLERID(data-area) / Partial: returns x"00"
TERMCODE(data-area) / Full
TERMPRIORITY(data-area) / Full
TEXTKYBD(data-area) / Partial: returns x"00" meaning "No"
TEXTPRINT(data-area) / Partial: returns x"00" meaning "No"
TRANPRIORITY(data-area) / Full
TWALENG(data-area) / Full
UNATTEND(data-area) / Full
USERID(data-area) / Full
USERNAME(data-area) / Partial: returns spaces
USERPRIORITY(data-area) / Full
VALIDATION(data-area) / Partial: returns x"00" meaning "No"

BIF DEEDIT

The BIF DEEDIT function is supported.

Operand / Support
FIELD(data-area) / Full
LENGTH(data-value) / Full

BUILD ATTACH

The BUILD ATTACH function is not supported.

Operand / Support
ATTACHID(data-value) / Recognized
DATASTR(data-area) / Recognized
IUTYPE(data-area) / Recognized
PROCESS(data-value) / Recognized
QUEUE(data-value) / Recognized
RECFM(data-area) / Recognized
RESOURCE(data-value) / Recognized
RPROCESS(data-value) / Recognized
RRESOURCE(data-value) / Recognized

CANCEL

The CANCEL function is supported.

Operand / Support
REQID(data-value) / Full
SYSID(data-value) / Full
TRANSID(data-value) / Full

CHANGE PASSWORD

The CHANGE PASSWORD function is not supported.

Operand / Support
ESMREASON(data-area) / Recognized
ESMRESP(data-area) / Recognized
NEWPASSWORD(data-value) / Recognized
PASSWORD(data-value) / Recognized
USERID(data-value) / Recognized

CHANGE TASK

The CHANGE TASK function is supported.

Operand / Support
PRIORITY(data-value) / Full

COLLECT STATISTICS

The COLLECT STATISTICS function is not supported.

Operand / Support
AUTOINSTALL / Recognized
CONNECTION(data-value) / Recognized
CORBASERVER / Recognized
DISPATCHER / Recognized
DTB / Recognized
FILE(data-value) / Recognized
IRCBATCH / Recognized
JOURNALNUM(data-value) / Recognized
JVMPOOL / Recognized
LASTRESET(data-area) / Recognized
LASTRESETHRS(data-area) / Recognized
LASTRESETMIN(data-area) / Recognized
LASTRESETSEC(data-area) / Recognized
LSRPOOL(data-value) / Recognized
MONITOR(data-value) / Recognized
PROGRAM(data-value) / Recognized
REQUESTMODEL / Recognized
SET(ptr-ref) / Recognized
STORAGE / Recognized
SYSDUMPCODE(data-value) / Recognized
TABLEMGR / Recognized
TASKCONTROL / Recognized
TCLASS(data-area) / Recognized
TCPIP / Recognized
TCPIPSERVICE / Recognized
TDQUEUE(data-value) / Recognized
TERMINAL(data-value) / Recognized
TRANDUMPCODE(data-value) / Recognized
TRANSACTION(data-value) / Recognized
TSQUEUE / Recognized
VTAM / Recognized

CONNECT PROCESS

The CONNECT PROCESS function is supported.

Operand / Support
CONVID(data-value) / Full
PARTNER / Validated
PIPLENGTH(data-value) / Full
PIPLIST(data-area) / Full
PROCLENGTH(data-value) / Full
PROCNAME(data-area) / Full
SESSION(data-value) / Full
STATE(cvda) / Full
SYNCLEVEL(data-value) / Full

CONVERSE

The CONVERSE function is supported.

Operand / Support
ALTERNATE / Full
ASIS / Full
CONVID(data-value) / Full
CTLCHAR(data-value) / Full
DEFAULT / Full
DEFRESP / Validated
DEST(data-value) / Validated
ERASE / Full
FMH / Full
FROM(data-area) / Full
FROMFLENGTH(data-value) / Full
FROMLENGTH(data-value) / Full
INTO(data-area) / Full
MAXFLENGTH(data-value) / Full
MAXLENGTH(data-value) / Full
NOTRUNCATE / Full
SESSION(data-value) / Full
SET(ptr-ref) / Full
STATE(cvda) / Full
STRFIELD / Full
TOFLENGTH(data-area) / Full
TOLENGTH(data-area) / Full

CREATE CONNECTION

The CREATE CONNECTION function is not supported.

CREATE CORBASERVER

The CREATE CORBASERVER function is not supported.

CREATE DB2CONN

The CREATE DB2CONN function is not supported.

CREATE DB2ENTRY

The CREATE DB2ENTRY function is not supported.

CREATE DB2TRAN

The CREATE DB2TRAN function is not supported.

CREATE DJAR

The CREATE DJAR function is not supported.

CREATE DOCTEMPLATE

The CREATE DOCTEMPLATE function is not supported.

CREATE ENQMODEL

The CREATE ENQMODEL function is not supported.

CREATE FILE

The CREATE FILE function is not supported.

CREATE JOURNALMODEL

The CREATE JOURNALMODEL function is not supported.

CREATE LSRPOOL

The CREATE LSRPOOL function is not supported.

CREATE MAPSET

The CREATE MAPSET function is not supported.

CREATE PARTITIONSET

The CREATE PARTITIONSET function is not supported.

CREATE PARTNER

The CREATE PARTNER function is not supported.

CREATE PROCESSTYPE

The CREATE PROCESSTYPE function is not supported.

CREATE PROFILE

The CREATE PROFILE function is not supported.

CREATE PROGRAM

The CREATE PROGRAM function is not supported.

CREATE REQUESTMODEL

The CREATE REQUESTMODEL function is not supported.

CREATE SESSIONS

The CREATE SESSIONS function is not supported.

CREATE TCPIPSERVICE

The CREATE TCPIPSERVICE function is not supported.

CREATE TDQUEUE

The CREATE TDQUEUE function is not supported.

CREATE TERMINAL

The CREATE TERMINAL function is not supported.

CREATE TRANCLASS

The CREATE TRANCLASS function is not supported.

CREATE TRANSACTION

The CREATE TRANSACTION function is not supported.

CREATE TSMODEL

The CREATE TSMODEL function is not supported.

CREATE TYPETERM

The CREATE TYPETERM function is not supported.

DEFINE COUNTER

The DEFINE COUNTER function is not supported.

Operand / Support
COUNTER(data-value) / Recognized
MAXIMUM(data-value) / Recognized
MINIMUM(data-value) / Recognized
POOL(data-value) / Recognized
VALUE(data-value) / Recognized

DEFINE DCOUNTER

The DEFINE DCOUNTER function is not supported.

Operand / Support
DCOUNTER(data-value) / Recognized
MAXIMUM(data-area) / Recognized
MINIMUM(data-area) / Recognized
POOL(data-value) / Recognized
VALUE(data-area) / Recognized

DELAY

The DELAY function is supported.

Operand / Support
FOR / Full
HOURS(data-value) / Full
INTERVAL(data-value) / Full
MINUTES(data-value) / Full
REQID(data-value) / Full
SECONDS(data-value) / Full
TIME(data-value) / Full
UNTIL / Full

DELETE

The DELETE function is supported.

Operand / Support
DATASET(data-value) / Full
FILE(data-value) / Full
GENERIC / Full
KEYLENGTH(data-value) / Full
NUMREC(data-area) / Full
RBA / Validated
RIDFLD(data-area) / Full
RRN / Full
SYSID(data-value) / Full
TOKEN(data-area) / Full

DELETE CONTAINER

The DELETE CONTAINER function is supported.

Operand / Support
CHANNEL(data-value) / Full
CONTAINER(data-value) / Full

DELETE COUNTER

The DELETE COUNTER function is not supported.

Operand / Support
COUNTER(data-value) / Recognized
POOL(data-value) / Recognized

DELETE DCOUNTER

The DELETE DCOUNTER function is not supported.

Operand / Support
DCOUNTER(data-value) / Recognized
POOL(data-value) / Recognized

DELETE RIDFLD

The DELETE RIDFLD function is supported.