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.
Function name | Parameters | Return codes: CICS_EPI_ |
---|---|---|
CICS_EpiInitialize | Version |
ERR_FAILED |
CICS_EpiTerminate | none | ERR_FAILED |
CICS_EpiListSystems | NameSpace |
ERR_FAILED |
CICS_EpiAddTerminal | NameSpace |
ERR_ALREADY_INSTALLED |
CICS_EpiAddExTerminal | System |
ERR_FAILED |
CICS_EpiInquireSystem | TermIndex |
ERR_BAD_INDEX |
CICS_EpiDelTerminal | TermIndex |
ERR_BAD_INDEX |
CICS_EpiPurgeTerminal | TermIndex |
ERR_BAD_INDEX |
CICS_EpiSetSecurity | TermIndex |
ERR_NOT_INIT |
CICS_EpiStartTran | TermIndex |
ERR_ATI_ACTIVE |
CICS_EpiReply | TermIndex |
ERR_BAD_INDEX |
CICS_EpiATIState | TermIndex |
ERR_ATI_STATE |
CICS_EpiGetEvent | TermIndex |
ERR_BAD_INDEX |
CICS_GetSysError | TermIndex |
ERR_NOT_INIT |
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.