Programmer Guide/Macro Library/UM: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 4: Line 4:
  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 the only 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.
: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 the only 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.
 
{|class="einrahmen"
=====Parameters:=====
!argument !!description !!default
 
|-
;<var>message</var>
|<var>text</var>
 
|The message text to be displayed.
:The message to display.
|
 
|-
=====Result:=====
|<var>title</var>
 
|The caption of the message box.
0
|<code>UM</code> or <code>EM</code>
 
|-
=====Description:=====
|<var>rc</var>
 
|The return code of the EM function. This must be an integer number.
A shorthand way to display a message to the user. See the macro BUTIL MSGBOX for more functionality.
|<code>-1</code>
 
|-
=====Examples:=====
|<var>level</var> || The number of macro levels to be closed (see command [[Programmer_Guide/Command_Reference/EXIT|<code>EXIT</code>]] for details)
 
| 2 (return to caller)
<pre>
!RESULT !!description
um Please press OK to continue
|-
</pre>
|''undefined'' || for the function <code>UM</code>
|<var>rc</var> || for the function <code>EM</code> (value is returned to the macro defined b< <var>level</var>)
|}

Revision as of 14:23, 29 January 2016

UM text [; title ]
Display the argument text in a message box with caption title (default: UM) and the only 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 the only button OK. When the dialog is closed use the command EXIT level INT rc to return.
argument description default
text The message text to be displayed.
title The caption of the message box. UM or EM
rc The return code of the EM function. This must be an integer number. -1
level The number of macro levels to be closed (see command EXIT for details) 2 (return to caller) RESULT description
undefined for the function UM rc for the function EM (value is returned to the macro defined b< level)

Navigation menu

Personal tools