The FEPI API commands

The FEPI application programming commands are:

The FEPI application programming commands are additions to the set of EXEC CICS® commands that are available to application programmers, and they have the same features and properties as those commands. Some brief notes of these features and properties appear below; for details, refer to the programming information on the following subjects in the CICS Application Programming Reference manual:

Command format

The general format of a command is:

EXEC CICS FEPI command option(argument)...

where:

command
Is the command name (for example, ALLOCATE).
option
Is an option name (for example, POOL).
argument
Is the source or destination for data, as required for the specified option, that is passed to or returned from the command.

The way that you end the command is determined by the programming language that you are using: COBOL, for example, requires an END-EXEC statement.

Arguments and data types

The text used to identify arguments in this book indicates the type of data represented by the argument and whether it is a value used by the command, or an area in which the command returns data. For example:

Errors and exception conditions

All FEPI commands support the RESP and RESP2 options to signal successful completion or an exception condition. Alternatively, you can use HANDLE CONDITION to trap errors.

Most FEPI command errors give the ‘INVREQ’ exception condition. The particular error in each case is uniquely identified by the RESP2 value.

If there is an error, the command does nothing and the output arguments are not changed. Note, however, that commands such as FEPI SEND may have transferred data before the condition is recognized.

Both RESP and RESP2 take, as an argument, the name of a user-defined fullword binary data area. Possible values of the RESP2 option are given in the description of each of the commands and a full list is given in RESP2 values. The following copy books provide declarations for the RESP2 values:

The INVREQ condition and the following RESP2 values can occur for any application programming command:

RESP2
Meaning
10
Command bypassed by user exit.
11
FEPI not installed, or not active..
12
CICS shutting down, command not allowed.
13
FEPI unavailable.
14
FEPI busy or cannot get storage..
15
Unknown command..
16
Internal error.
17
FEPI cannot get storage for user exit..
18
Command failed through operator or system action..

Syntax notation

The notation used in this book to show the syntax of FEPI commands is the same as that used in the CICS System Programming Reference manual.

Translator options

You must specify the ‘FEPI’ translator option when you use FEPI commands.

Other points

[[ Contents Previous Page | Next Page Index ]]