OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

[Contents][Index][Back][Next]

5.1.2 Format of COBOL-UAP creation program descriptions

When you create a CUP in COBOL, use a CALL statement to call the COBOL-UAP creation program that corresponds to the function in the TP1/Client library.

In 6. Request Statements Available for TP1/Client (COBOL Language), each COBOL-UAP creation program is described in a format that consists of the following elements:

Form
Shows the form of calling the COBOL-UAP creation program corresponding to the function in the library using the CALL statement and how to specify areas.
The form is common to COBOL/2 and COBOL85. When you specify a value for the data name, follow the data format of the PICTURE clause indicated here. When necessary values are predefined, the VALUE clause specifies them.
Unless otherwise specified, give specific names to the file name and the data name indicated by the identifier.
Follow COBOL specifications for a character length specified as a data name.

Purpose
Explains the COBOL-UAP creation program function using the following format.
CBLDCXXX('YYYYYYYY')
YYYYYYYY
Request code
CBLDCXXX
Name of the COBOL-UAP creation program

Data area where the UAP sets values
Provides data names whose values need to be specified in the data area when the COBOL-UAP creation program is called. The corresponding data in contained in DATA DIVISION. Specify proper values based on respective data descriptions.

Data area for containing the returned values
Provides names of data area in which to contain values returned by OpenTP1, server UAP, and TP1/Client after a CALL statement is executed.

Status codes
Describes values returned when the CALL statement is executed. Values are presented in a tabular form. A status code shows whether the COBOL-UAP creation program has executed normally. When an error occurs, the corresponding status code shows its content.
A COBOL status code consists of five digits. It is contained in the first identifier that is specified in the USING clause. The following shows how the CALL statement and the USING clause represent identifiers and a status code.
[Figure]

Notes
Precautions on using respective COBOL-UAP creation programs.
Organization of this subsection
(1) Symbols used for describing the items to be specified

(1) Symbols used for describing the items to be specified

The following table lists the symbols that are used for describing the items to be specified.

Symbol Description
[ ] The item enclosed between brackets can be omitted.

Example:
[:port-number]
":port-number" can be omitted.
... This symbol indicates a description is omitted. The item immediately before this symbol can be specified more than once consecutively.

Example:
host-name [:port-number][,host-name [:port-number],...]
"host-name [:port-number]" can be specified more than once consecutively.
~ The item before this symbol conforms to the rule indicated in < > or (( )) after ~.
<character string> Any character(s)
<unsigned integer> Numbers 0 to 9
(( )) The specification range of the specified value is indicated.