Each entry on the following pages includes a functional description, the syntax (including the datatype of each argument), an example, possible return codes, and a list of related function, topics, and documentation. All arguments of each function are required unless designated as optional.
Most examples in this chapter are taken from the sample programs in the appendices. These programs show how individual functions are coded in context. Refer to the appendices to learn how to set up your WORKING STORAGE SECTION and to see examples of complete programs.
Your application must include a set of constants supplied with Open ServerConnect. These are standard argument options and return values for the COBOL Gateway-Library interface. To include these constants in a COBOL program, include the copybook SYGWCOB in the program.
When you use Gateway-Library functions, be aware of the following information:
For most Gateway-Library functions, the return codes for Gateway-Library functions are stored in a RETCODE argument. Where this argument exists, it is always the second argument for a function.
The TDPROC structure is established by the TDACCEPT function. TDPROC is a required argument of all subsequent functions that use the same connection (except tracing and accounting functions). In most cases, TDPROC is the first argument.
The maximum length allowed for names is 30 bytes.
For numeric and alphabetic lists of all return codes,
including descriptions, see Mainframe Connect Client Option and
Server Option Messages and Codes.
