VAXTPU MESSAGE_TEXT — VMS 5.2

 MESSAGE_TEXT

 Allows you to fetch the text associated with a message code.  Also allows
 you to substitute strings or integers into the text.  MESSAGE_TEXT is
 especially useful if you access VAXTPU through the callable interface and
 link in your own message file.

 Syntax

    [string := ] MESSAGE_TEXT ({integer1 | keyword} [, integer2
                               [, FAO parameters]])

 Parameters

    keyword              The keyword for the message code associated with
                         the text that is to be fetched.  VAXTPU provides
                         keywords for all the message codes used by VAXTPU
                         and EVE.

    integer1             The integer for the message code associated with
                         the text that is to be fetched.

    integer2             A bit-encoded integer controlling which portions
                         of the message are fetched.  If the message flags
                         are not specified, or if the value of a message
                         flag is set to zero, then the value specified by
                         the SET (MESSAGE_FLAGS...) built-in is used.  The
                         meanings of the message flags are as follows:

         Bit VAXTPU Constant           Meaning

         0   TPU$K_MESSAGE_TEXT       Include text of message

         1   TPU$K_MESSAGE_ID         Include message identifier

         2   TPU$K_MESSAGE_SEVERITY   Include severity level indicator

         3   TPU$K_MESSAGE_FACILITY   Include facility name

    FAO parameters       Strings and integers to be substituted into the
                         text associated with the message code.  The
                         message code is specified by the first parameter.
                         FAO directives for substituting strings and
                         integers are provided within the message text.  A
                         maximum of 20 FAO parameters are allowed.  For a
                         description of the FAO directives, see the VMS
                         System Services Reference Manual.  For more
                         information on the FAO built-in in VAXTPU, see the
                         description of that built-in in Chapter 4 of the
                         VAX Text Processing Utility Manual.

 Example

    openin_text := MESSAGE_TEXT (tpu$_openin, TPU$K_MESSAGE_TEXT, "FOO.BAR");

 Fetches the text associated with the message code TPU$_OPENIN.  The
 statement substitutes the string "FOO.BAR" into the message.  VAXTPU
 fetches the entire text of the message.  The string "Error opening FOO.BAR
 as input" is stored in the variable OPENIN_TEXT.
Museum

VAXTPU MESSAGE_TEXT — VMS 5.2
