OpenTP1 Version 7 Programming Reference C Language

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

Format for explaining functions

This section explains functions provided by OpenTP1 in the following format:

Format

Indicates the formats of OpenTP1 library functions and the data types of arguments.

To code a UAP in C++ language or the ANSI C format, see the format provided under ANSI C, C++ in the function's Format section. To code a UAP in the pre-ANSI K&R format, see the format provided under K&R C in the function's Format section.

Use the data types given in this section when allocating values to arguments. A specific name can be arbitrarily assigned to an argument if not specially noted.

Description

Explains the facilities of the corresponding function.

Argument(s) whose value(s) is set in the UAP

Indicates the argument(s) whose value(s) should be specified when the function is executed. Specify a value for each argument according to the explanation. If a value is not always specified for an argument, the explanation of the argument is enclosed in brackets [ ] when the value is specified for the argument.

Argument(s) whose value(s) is returned from OpenTP1

Indicates the argument(s) whose value(s) is returned from OpenTP1 after the function is executed. Reference the contents of the argument after the function is executed. If a value is not always returned to an argument from OpenTP1, the explanation of the argument is enclosed in brackets [ ] when the value is returned.

Argument(s) whose value(s) is passed from a client UAP

Indicates the argument(s) whose value(s) is passed from the client UAP when the service function is used. Execute service function processing referencing the contents of the argument.

Argument(s) whose value(s) is returned from a server UAP

Indicates the argument(s) whose a value(s) is returned from the service function when a synchronous-response-type RPC or asynchronous-response-type RPC is used. The UAP that called the function dc_rpc_call() or the function dc_rpc_poll_any_replies() can reference the value of the argument shown here.

Return values

Values returned when the function is executed are explained in a table. The return value indicates whether the function was executed normally. If an error occurs, the return value indicates the error status.

To maintain interchangeability, use the return value with the constant name shown here when creating a UAP. The constant name of the return value is defined in the header file. Reference the header file definition when you need the information of the return value.

Example

Provided only for functions with which examples are necessary

Note(s)

Explains a note(s) on using the function.