This appendix describes the return codes that Gateway-Library returns to functions to indicate the result of the function’s execution. These values are returned to the argument, RETCODE, which is the second argument of most Gateway-Library functions.
Some return codes are informational, such as TDS-RESULTS-COMPLETE. Others are warning or error codes, such as TDS-INVALID-PARAMETER. When the function executes as expected, the return code is TDS-OK.
Many return codes are function-specific and are returned to only one function. Others, such as TDS-OK, can be returned to many Gateway-Library functions.
Gateway-Library return codes all begin with “TDS.” Client-Library return codes begin with CS. However, on the mainframe, a few TDS return codes are returned to Client-Library functions. Some are returned to both Gateway-Library and Client-Library functions.
A list of all return codes, with their definition statements, is in the data set SYGWCOB or SYGWPLI, which is provided with the Server Option API.
The first set of lists—one for informational messages, one for error and warning messages—is in numeric order. An alphabetical list follows, with brief descriptions for each code.
For PL/1, the return codes use underscores
(_) instead of
hyphens(-).
