%ExplainMessage meta-HTML element

Syntax

%ExplainMessage(message_set, message_num [, alt_msg_text])

Description

Use the %ExplainMessage function to retrieve the Description field (that is, the explain, or detailed text) for a message from the message catalog.

Note:

Use this function in HTML definitions only.

Note:

This variable is valid for use in auxiliary JavaScript files.

Parameters

Parameter	Description
message_set	Specifies the message set as an Integer value.
message_num	Specifies the message number as an Integer value.
alt_msg_text	Specifies a String value representing an alternate message to be used if the message set and number are not found in the message catalog. Note: The alternate message is used as is. Any quotation marks used to enclose the alternate message will be output as part of the message instead. In addition, because a comma is used as a separator between parameters, a comma will truncate the alternate message.

Example 1

The following example demonstrates usage of the %ExplainMessage function:

%ExplainMessage(124, 528, Message Not Found: Click Yes to go back and save; No to discard your changes)

The resulting description is returned from the message catalog:

Click Yes to go back and save, No to discard your changes

Example 2

The following example specifies a message set and number that is undefined in the message catalog:

%ExplainMessage(124, 999, "Message Not Found: Click Yes to go back and save, No to discard your changes")

Because the alternate message includes a comma, it would be truncated as follows:

"Message Not Found: Click Yes to go back and save