next up previous 211
Next: MSG_RENEW - Renew any annulled message tokens in the current context
Up: Subroutine Specifications
Previous: MSG_OUT - Output a message


MSG_OUTIF - Conditionally deliver the text of a message to the user

Description:
If the given message priority, PRIOR, and the current message filtering level (set by MSG_IFSET or MSG_IFGET) indicate that the message should be delivered, the message text is expanded and output to the user. If not, the message is discarded. In either case, any existing message tokens are then annulled. If the expanded message exceeds the maximum allowed size, it will be terminated by an ellipsis (i.e. ``...'') but no error results.

If STATUS is not set to SAI__OK on entry, no action is taken except to annul existing message tokens.

If an output error occurs, an error is reported and STATUS returned set to MSG__OPTER.


Invocation:
CALL MSG_OUTIF( PRIOR, PARAM, TEXT, STATUS )

Arguments:

PRIOR = INTEGER (Given)
Message output priority. This may be one of three values defined in the MSG_PAR include file:
  • MSG__QUIET = Always output the message, regardless of the output filter setting;

  • MSG__NORM = Output the message unless the current output filter is set to MSG__QUIET;

  • MSG__VERB = Do not output the message unless the current output filter is set to MSG__VERB.

If any other value is given, STATUS is set to MSG__INVIF and an error report made; no further action will be taken.
PARAM = CHARACTER * ( * ) (Given)
The message name.
TEXT = CHARACTER * ( * ) (Given)
The message text.
STATUS = INTEGER (Given and Returned)
The global status.



next up previous 211
Next: MSG_RENEW - Renew any annulled message tokens in the current context
Up: Subroutine Specifications
Previous: MSG_OUT - Output a message

MERS (MSG and ERR) Message and Error Reporting Systems
Starlink User Note 104
P C T Rees
A J Chipperfield
22 October 2001
E-mail:ussc@star.rl.ac.uk

Copyright © 2001 Council for the Central Laboratory of the Research Councils