$FORMATMSG (set a message format)

$FORMATMSG sets the format of a character string that is output to a message.

Organization of this page

Syntax

message=$FORMATMSG(message-text,character-string-1(,character-string-2(,...)))

message

Specifies a message, expressed as a variable.
message-text

Specifies the character string whose format is to be set, as either a constant or a variable. A constant must be enclosed in single quotation marks ('').
character-string

Specifies the character string to be inserted in the message text, as either a constant or a variable. A constant must be enclosed in single quotation marks ('').

A maximum of 99 character strings can be specified.

The following table lists and describes the possible statuses:

Status	Description
`NORMAL`	Normal end
`ERROR`	—
Script execution interrupted	Indicates one of the following: More than 99 arguments were specified. An invalid argument was specified, or an error other than the above occurred.

Status

Description

NORMAL

Normal end

ERROR

—

Script execution interrupted

Indicates one of the following:

This example outputs a message with the asset number and the processing inserted:

MSG = $FORMATMSG('Device %2 on asset number %1 failed','1001','deletion')
$ECHO(MSG)