Usage Notes
The Message Text field is the text of the message indicated by Return Code. Message Text is available in the DBCAREA after every call to DBCHCL even those with return code of zero.
| Language | Variable Name |
|---|---|
| COBOL: | DBCAREA-MSG-TEXT |
| C: DBCAREA.H: | msg_text |
| Routine | Action Taken |
|---|---|
| DBCHINI: | writes |
| DBCHCL: | writes |
| Used by | Action Taken |
|---|---|
| application program | reads |
Only Message Length bytes are guaranteed to be affected in Message Text.
An error message is returned when a CLI routine that uses the DBCAREA ends with a non-zero/Zero return code. The message will be contained in Message Text field within the DBCAREA only if the area addressed by Message Area Pointer is NULL. Message Length will return the length of the message.
Language used to return the message in this field is driven by the Language Id field in DBCAREA. If an error occurs before the Language Id is determined, CLI will return the error message in English.