Abstract API Specification
Abstract API specification.
This section presents the abstract syntax for the
RLX
/CAF services. The following table describes the meanings of the literal constants and host variables (denoted by :hv_
) that appear in the syntax diagrams.- :hv_dsnDenotes a host variable whose value is set to the name of a Db2 subsystem.
- :hv_planDenotes a host variable which has as a value the name of a Db2 application plan.
- :hv_pgmDenotes a host variable which has as a value the name of aRLXSQL load module.
- :hv_closeDenotes a host variable whose value is either SYNC or ABRT.
- :hv_handleDenotes a host variable whose value is the handle for an application thread established by either the CREATE THREAD or ACTIVATE service.
- :hv_ddnameDenotes a host variable whose value is set to the DD name used to identify the library from which the Db2 andRLX/CAF routines will be loaded.
- :hv_estaeDenotes a host variable whose value is either YES or NO.
- *Designates a default value for a parameter.
- dsnDenotes a literal character string representing the Db2 subsystem name.
- planDenotes a literal character string representing the name of the Db2 application plan.
- pgmDenotes a literal character string representing the name of aRLXSQL load module.
- ddnameIs the name of the file which identifies the Db2 load library (e.g. DSN.SDSNLOAD).
- defaultsDenotes the name of run-time parameter defaults module.
The syntax of
RLX
/CAF services is presented in the form of railroad diagrams. When coded in a REXX application, each RLX
/CAF service depicted in the diagrams should be prefixed with the "CAF ..." keyword.