Functions

EYUAPI()

Passes an API command to CICSPlex® SM.

   var = EYUAPI(command string)
 
       OR
 
   var = EYUAPI('command string')

Description

This function passes an API command to CICSPlex SM. You must issue an EYUAPI or EYUINIT function before you can use the ADDRESS CPSM command to pass API commands to REXX.

Options

command string
Identifies the API command and options to be passed.

Return codes

The following is a list of the REXX return codes that can be returned by the EYUAPI function in its assigned variable (var).

These return codes indicate what REXX did with the EYUAPI function; they do not indicate whether the API command that was passed was successfully processed by CICSPlex SM. For that information, you must refer to the RESPONSE and REASON values returned by the command.

0
The EYUAPI function was successful.
1
The EYUAPI function failed.

EYUINIT()

Initialize the CICSPlex SM API environment and allocate the necessary resources.

   var = EYUINIT()

Description

This command initializes the CICSPlex SM API environment and allocates the necessary resources. EYUINIT should be the first function issued in a REXX program.

Note:
You must issue an EYUINIT or EYUAPI function before you can use the ADDRESS CPSM command to pass API commands to REXX.

Return codes

The following is a list of the REXX return codes that can be returned by the EYUINIT function in its assigned variable (var).

0
The EYUINIT function was successful.
1
The EYUINIT function failed.
 
 

EYUREAS()

Translate the numeric value returned by the REASON option of an API command.

   var = EYUREAS(reason)

Description

This command translates the numeric value returned by the REASON option of an API command into its character equivalent and vice versa.

Options

reason
Is the REASON value to be translated.

Return codes

The following is a list of the REXX return codes that can be returned by the EYUREAS function in its assigned variable (var).

nnnn
The numeric or character equivalent of the specified REASON value.
-1
The specified REASON value is invalid and could not be translated.
 

EYURESP()

Translate the numeric value returned by the RESPONSE option of an API command.

   var = EYURESP(response)

Description

This command translates the numeric value returned by the RESPONSE option of an API command into its character equivalent and vice versa.

Options

response
Is the RESPONSE value to be translated.

Return codes

The following is a list of the REXX return codes that can be returned by the EYURESP function in its assigned variable (var).

nnnn
The numeric or character equivalent of the specified RESPONSE value.
-1
The specified RESPONSE value is invalid and could not be translated.
 
 

EYUTERM()

Terminate the CICSPlex SM API environment and release any allocated resources.

   var = EYUTERM()

Description

This command terminates the CICSPlex SM API environment and releases any allocated resources. EYUTERM should be the last function issued in a REXX program.

Note:
If the CICSPlex SM host subcommand environment is actually installed at your enterprise (as opposed to being called from the function package), you may not need to use EYUTERM at the end of every program. The resources that remain allocated can be reused by the next program that accesses the host subcommand environment.

Return codes

The following is a list of the REXX return codes that can be returned by the EYUTERM function in its assigned variable (var).

0
The EYUTERM function was successful.
1
The EYUTERM function failed.
[[ Contents Previous Page | Next Page Index ]]