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

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

3.1.2 Format of function descriptions

TP1/Client functions are described in the following format:

Form
Shows the definition form of the TP1/Client library function and the argument data types. Use the listed data types when setting arguments for the function.

Purpose
Describes what the function does.

Arguments set by UAPs
Shows the arguments that must be set at function execution. Set each argument according to the given description.

Arguments that contain return values
Shows the arguments that reference the values returned by OpenTP1, server UAP, and TP1/Client when the function was previously executed.

Return values
Table of return values indicating whether the function executed correctly. If an error occurred, the return value indicates the error type.
When developing a UAP, always use the listed definition names rather than the numerical values. Return value definition names are defined in the header file.

Notes
Precautions on using the function.
Organization of this subsection
(1) Symbols used for describing the values specified as arguments
(2) Description of the symbols specified as arguments

(1) Symbols used for describing the values specified as arguments

The following tables lists the symbols that are used for describing the values specified as function arguments.

Symbol Description
{ } Select one of the items enclosed between braces.

Example:
{DCCLT_CNV_EBCDIC|DCCLT_CNV_EBCDIK}
In this case, specify either DCCLT_CNV_EBCDIC or DCCLT_CNV_EBCDIK.
[ ] The item enclosed between brackets can be omitted.

Example:
[DCNOFLAGS]
DCNOFLAGS can be omitted.
_ (underscore) When all the items enclosed between brackets are omitted, TP1/Client assumes the default indicated by an underscore.

Example:
[{DCCLT_CNV_SPCHAN|DCCLT_CNV_SPCZEN}]
When both DCCLT_CNV_SPCHAN and DCCLT_CNV_SPCZEN are omitted, DCCLT_CNV_SPCZEN is assumed.
... 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 between < > or (( )) described after ~.
<character string> Any character(s)
<unsigned integer> Numbers 0 to 9
(( )) The specification range of the specified value is indicated.

(2) Description of the symbols specified as arguments

The following table lists the symbols specified as arguments.

Symbol Description
| (Stroke) This symbol delimits the items that are specified in a single argument. Insert the symbol between items.
Example:
{DCCLT_CNV_EBCDIC|DCCLT_CNV_EBCDIK}
[|{DCCLT_CNV_SPCHAN|DCCLT_CNV_SPCZEN}]
When specifying DCCLT_CNV_EBCDIC and DCCLT_CNV_SPCHAN, specify "DCCLT_CNV_EBCDIC|DCCLT_CNV_SPCHAN".