EPI functions

This section describes the functions provided by the EPI that can be called from an application program:

Table 1 summarizes the functions of the interface, the parameters passed to each function, and the possible return codes from each function.

The mapping of actual return code values to the symbolic names is contained in the following file for the Windows® operating systems:
C
\include\cics_eci.h
Cobol
\copybook\cicsepi.cbl
and in the following files for the UNIX® and Linux® operating systems:
C
/include/cics_eci.h
Table 1. Summary of EPI functions
Function name Parameters Return codes: CICS_EPI_
CICS_EpiInitialize

Version

ERR_FAILED
ERR_IS_INIT
ERR_VERSION
NORMAL

CICS_EpiTerminate none

ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
NORMAL

CICS_EpiListSystems

NameSpace
Systems
List

ERR_FAILED
ERR_MORE_SYSTEMS
ERR_NO_SYSTEMS
ERR_NOT_INIT
ERR_NULL_PARM
ERR_IN_CALLBACK
NORMAL

CICS_EpiAddTerminal

NameSpace
System
Netname
DevType
NotifyFn
Details
TermIndex

ERR_ALREADY_INSTALLED
ERR_FAILED
ERR_IN_CALLBACK
ERR_MAX_SESSIONS
ERR_MAX_SYSTEMS
ERR_MODELID_INVALID
ERR_NOT_3270_DEVICE
ERR_NOT_INIT
ERR_NULL_PARM
ERR_RESOURCE_SHORTAGE
ERR_SECURITY
ERR_SERVER_BUSY
ERR_SERVER_DOWN
ERR_SYSTEM
ERR_TERMID_INVALID
NORMAL

CICS_EpiAddExTerminal

System
Netname
DevType
NotifyFn
Details
TermIndex
Attributes

ERR_FAILED
ERR_NOT_INIT
ERR_SYSTEM
ERR_SECURITY
ERR_NULL_PARM
ERR_VERSION
ERR_IN_CALLBACK
ERR_SERVER_DOWN
ERR_RESPONSE_TIMEOUT
ERR_SIGNON_NOT_POSS
ERR_PASSWORD_INVALID
ERR_ADDTYPE_INVALID
ERR_SIGNONCAP_INVALID
ERR_USERID_INVALID
ERR_TERMID_INVALID
ERR_MODELID_INVALID
ERR_NOT_3270_DEVICE
ERR_ALREADY_INSTALLED
ERR_CCSID_INVALID
ERR_SERVER_BUSY
ERR_RESOURCE_SHORTAGE
ERR_MAX_SESSIONS
ERR_MAX_SYSTEMS
NORMAL

CICS_EpiInquireSystem

TermIndex
System

ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_NULL_PARM
ERR_IN_CALLBACK
NORMAL

CICS_EpiDelTerminal

TermIndex

ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_TRAN_ACTIVE
ERR_IN_CALLBACK
NORMAL

CICS_EpiPurgeTerminal

TermIndex

ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_VERSION
NORMAL

CICS_EpiSetSecurity

TermIndex
UserId
Password

ERR_NOT_INIT
ERR_BAD_INDEX
ERR_IN_CALLBACK
ERR_SYSTEM_ERROR
ERR_VERSION
ERR_PASSWORD_INVALID
ERR_USERID_INVALID
ERR_NULL_PASSWORD
ERR_NULL_USERID
NORMAL

CICS_EpiStartTran

TermIndex
TransId
Data
Size

ERR_ATI_ACTIVE
ERR_BAD_INDEX
ERR_FAILED
ERR_NO_DATA
ERR_NOT_INIT
ERR_TTI_ACTIVE
ERR_IN_CALLBACK
ERR_SERVER_DOWN
ERR_RESOURCE_SHORTAGE
ERR_MAX_SESSIONS
NORMAL

CICS_EpiReply

TermIndex
Data
Size

ERR_BAD_INDEX
ERR_FAILED
ERR_NO_CONVERSE
ERR_NO_DATA
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_ABENDED
ERR_SERVER_DOWN
NORMAL

CICS_EpiATIState

TermIndex
ATIState

ERR_ATI_STATE
ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_NULL_PARAM
NORMAL

CICS_EpiGetEvent

TermIndex
Wait

ERR_BAD_INDEX
ERR_FAILED
ERR_MORE_DATA
ERR_MORE_EVENTS
ERR_NO_EVENT
ERR_NOT_INIT
ERR_WAIT
ERR_NULL_PARAM
ERR_IN_CALLBACK
NORMAL

CICS_GetSysError

TermIndex
SysErr

ERR_NOT_INIT
ERR_BAD_INDEX
ERR_FAILED
ERR_NULL_PARAM
ERR_VERSION
NORMAL

Refer to the definitions of the functions to discover the types and usage of the parameters, the data structures used by the functions, and the meanings of the return codes.