Return Code - Call-Level Interface Version 2

Teradata® Call-Level Interface Version 2 Reference for Workstation-Attached Systems - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Call-Level Interface Version 2
Release Number
20.00
Published
January 2024
ft:locale
en-US
ft:lastEdition
2024-11-15
dita:mapPath
bmn1691484839905.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
fvz1470444150352
lifecycle
latest
Product Category
Teradata Tools and Utilities

Usage Notes

The Return Code field specifies the state of the call as known by DBCHCL and MTDP.

Language Variable Name
COBOL: DBCAREA-RETURN-CD
C: DBCAREA.H: return_cd
Routine Action Taken
DBCHINI: writes
DBCHCL: writes
Used by Action Taken
application program reads

After regaining control from DBCHCL, the application program uses Return Code as the first indicator (initial status) of the success of the call.

A return code of zero indicates the call is successful as far as CLI and MTDP know. It does not imply the call is successful on the database computer. The application program determines that by examining the first parcel in the response.

The return code from a call to DBCHCL is output as the value in Return Code in the DBCAREA, the value in Return Code in the parameter list of DBCHCL, and the returned value of the DBCHCL function. The return code is identical in all three places.