Programmer Guide/Macro Library/UM - Revision history

Jw at 08:38, 17 January 2017

2017-01-17T08:38:32Z

← Older revision		Revision as of 10:38, 17 January 2017
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 the only 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 the only button <code>OK</code>. This function is a shortcut for <code>[[Programmer_Guide/Macro_Library/BUTIL#MsgBox\|BUTIL MSGBOX MSG]]</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 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 from <var>level</var> macro levels.		: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 from <var>level</var> macro levels.

Toni at 12:33, 29 January 2016

2016-01-29T12:33:06Z

← Older revision		Revision as of 14:33, 29 January 2016
Line 34:		Line 34:
	[macro umemtest]		[macro umemtest]
	um press OK key to continue; UM - waiting for user input		um press OK key to continue; UM - waiting for user input
	em 107 2; press OK to exit this macro with return code 107; EM - waiting for user input		em 107; press OK to exit this macro with return code 107; EM - waiting for user input
	// this point should nevel be reached!		// this point should nevel be reached!
	conlog '$#mac: you should never see this message - something goes wrong!'		conlog '$#mac: you should never see this message - something goes wrong!'
	exit 1 int 0		exit 1 int 0
	</pre>		</pre>

Toni at 12:31, 29 January 2016

2016-01-29T12:31:51Z

← Older revision		Revision as of 14:31, 29 January 2016
Line 32:		Line 32:
	Example:		Example:
	<pre>		<pre>
	~~...~~		[macro umemtest]
	um press OK key to continue; UM - waiting for user input		um press OK key to continue; UM - waiting for user input
	~~...~~
	em 107 2; press OK to exit this macro with return code 107; EM - waiting for user input		em 107 2; press OK to exit this macro with return code 107; EM - waiting for user input
	~~exit 1 int 0~~ // this point should ~~never~~ be reached!		// this point should nevel be reached!
			conlog '$#mac: you should never see this message - something goes wrong!'
			exit 1 int 0
	</pre>		</pre>

Toni at 12:30, 29 January 2016

2016-01-29T12:30:05Z

← Older revision		Revision as of 14:30, 29 January 2016
Line 29:		Line 29:
	\|<var>rc</var> \|\| for the function <code>EM</code> (value is returned to the macro defined b< <var>level</var>)		\|<var>rc</var> \|\| for the function <code>EM</code> (value is returned to the macro defined b< <var>level</var>)
	\|}		\|}

			Example:
			<pre>
			...
			um press OK key to continue; UM - waiting for user input
			...
			em 107 2; press OK to exit this macro with return code 107; EM - waiting for user input
			exit 1 int 0 // this point should never be reached!
			</pre>

Toni at 12:26, 29 January 2016

2016-01-29T12:26:42Z

← Older revision		Revision as of 14:26, 29 January 2016
Line 3:		Line 3:
	:Display the argument <var>text</var> in a message box with caption <var>title</var> (default: <code>UM</code>) and the only 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 the only 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 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 from <var>level</var> macro levels.
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Toni at 12:25, 29 January 2016

2016-01-29T12:25:39Z

← Older revision		Revision as of 14:25, 29 January 2016
Line 3:		Line 3:
	:Display the argument <var>text</var> in a message box with caption <var>title</var> (default: <code>UM</code>) and the only 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 the only 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 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"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Toni at 12:24, 29 January 2016

2016-01-29T12:24:48Z

← Older revision		Revision as of 14:24, 29 January 2016
Line 26:		Line 26:
	\|-		\|-
	\|''undefined'' \|\| for the function <code>UM</code>		\|''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>)		\|<var>rc</var> \|\| for the function <code>EM</code> (value is returned to the macro defined b< <var>level</var>)
	\|}		\|}

Toni at 12:24, 29 January 2016

2016-01-29T12:24:27Z

← Older revision		Revision as of 14:24, 29 January 2016
Line 19:		Line 19:
	\|<code>-1</code>		\|<code>-1</code>
	\|-		\|-
	\|<var>level</var> \|\| The number of macro levels to be closed (see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)		\|<var>level</var>
	\| 2 (return to caller)		\| The number of macro levels to be closed (see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)
			\| <code>2</code> (return to caller)
			\|-
	!RESULT !!description		!RESULT !!description
	\|-		\|-

Toni at 12:23, 29 January 2016

2016-01-29T12:23:07Z

← Older revision		Revision as of 14:23, 29 January 2016
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>)
			\|}

Toni at 12:15, 29 January 2016

2016-01-29T12:15:50Z

← Older revision		Revision as of 14:15, 29 January 2016
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 the only 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.		: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.

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