15.10 - Message Text - Call-Level Interface Version 2

Teradata Call-Level Interface Version 2 Reference for Mainframe-Attached Systems

prodname
Call-Level Interface Version 2
vrm_release
15.10
category
Programming Reference
featnum
B035-2417-035K

Message Text is a 76-byte fie­ld that is the text of the message indicated by Return Code. The language of the text is specified by the Language Id and the Country Id options

 

In this language...

The variable name for Message Text is...

COBOL

DBCAREA‑MSG‑TEXT

PL/I

MSG_TEXT

C

msg_text

IBM Assembler

DBCMSG

 

This routine...

Does this for Message Text...

DBCHINI

writes

DBCHCL

writes

 

Message Text is used by...

To...

applications

read

An error message is returned when a CLIv2 routine that uses the DBCAREA ends with a non-zero return code. The message is 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 Message Area Pointer is not specified, the Message Text field contains the message and Message Text Length returns the length of the message. If Message Area Pointer is specified, the area addressed contains the message and Message Length returns the length of the message.

If an error occurs while building the message, the Message Return Code field contains a CLIv2 return code. When this code is not zero, the text of the message may or may not be usable, depending on the nature of the error.

The character set used to construct the message is indicated by Message Charset Used. The session character set is always used if it is known, but if the error occurred before this character set is known, the default CLIv2 character set is used.

If the character set requires more than one byte per character, it may exceed the size of Message Text. Message Area Pointer may be used to provide a larger area for the message.

When a CLIv2 routine that uses the DBCAREA ends with a zero return code, any text from a previous error is overwritten with spaces in the character set indicated by Message Charset Used, and the length of the message is zeroed.