17.10 - Message Area Pointer - Call-Level Interface Version 2

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

Product
Call-Level Interface Version 2
Release Number
17.10
Release Date
October 2021
Content Type
Programming Reference
Publication ID
B035-2418-061K
Language
English (United States)

Usage Notes

The Message Area Pointer field specifies the address of an area into which any error message will be placed.

The Message Area Length field specifies the length of the addressed area. CLI does not alter this value, so after it is set, it remains unless changed by the application.

Language Variable Name
COBOL: DBCIMSGP
C: DBCAREA.H: dbciMsgP (case-sensitive)
Routine Action Taken
DBCHINI: writes
DBCHCL: reads
Used by Action Taken
application program writes

An error message is returned when a CLI routine that uses the DBCAREA returns a non-zero return code. The message will be contained either in the Message Text field within the DBCAREA or in the area addressed by Message Area Pointer. A message is never returned in both places. If a Message Area Pointer in not specified, the Message Text field will contain the message and Message Length will return the length of the message. If a Message Area Pointer is specified, the area addressed will contain the message and Message Length will return the length of the message.

If an error occurs while building the message, the Message Return Code field will contain a CLI return code. When this code is non- zero, the text of the message may be usable, depending on the nature of the error.

Messages are returned in this area depending on the Language Id specified by the application. If an error occurs before the Language Id is determined, CLI will return the message in English.