Programmer Guide/Macro Library/UM: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:UM or EM - Display a User-Message (UM) or Error-Message (EM)}}
{{DISPLAYTITLE:UM or EM - Display a User-Message (UM) or Error-Message (EM)}}
  UM <var>text</var> [; <var>title</var> ]
  UM <var>text</var> [; <var>title</var> ]
:Display the argument <var>text</var> in a message box with caption <var>title</var> (default: <code>UM</code>) and only the button <code>OK</code>. This function is a shortcut for <code>MSGBOX MSG <var>text</var> [; <var>title</var>=UM]</code>.
:Display the argument <var>text</var> in a message box with caption <var>title</var> (default: <code>UM</code>) and only the button <code>OK</code>. This function is a shortcut for <code>MSGBOX MSG; <var>text</var> [; <var>title</var>=UM]</code>.
  EM [ <var>rc</var>=-1 [ <var>level</var>=2 ]] ; <var>text</var> [; <var>title</var> ]  
  EM [ <var>rc</var>=-1 [ <var>level</var>=2 ]] ; <var>text</var> [; <var>title</var> ]  
 
:Display the string <code>ERROR (<var>rc</var>) <var>text</var></code> in a message box with caption <var>title</var> (default: <code>EM</code>) and only the button <code>OK</code>. When the dialog is closed use the command [[Programmer_Guide/Command_Reference/EXIT|<code>EXIT <var>level</var> INT <var>rc</var></code>]] to return.


=====Parameters:=====
=====Parameters:=====

Revision as of 13:15, 29 January 2016

UM text [; title ]
Display the argument text in a message box with caption title (default: UM) and only the button OK. This function is a shortcut for MSGBOX MSG; text [; title=UM].
EM [ rc=-1 [ level=2 ]] ; text [; title ] 
Display the string ERROR (rc) text in a message box with caption title (default: EM) and only the button OK. When the dialog is closed use the command EXIT level INT rc to return.
Parameters:
message
The message to display.
Result:

0

Description:

A shorthand way to display a message to the user. See the macro BUTIL MSGBOX for more functionality.

Examples:
um Please press OK to continue

Navigation menu

Personal tools