Programmer Guide/Macro Library/CONLOG - Revision history

Toni at 08:37, 15 March 2018

2018-03-15T08:37:29Z

← Older revision		Revision as of 10:37, 15 March 2018
Line 27:		Line 27:
	(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)		(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)
	\|-		\|-
	\|<code>Result</code><BR><code>Result=</code><var>res</var>		\|<code>/Ton</code>
			\|Turn timer on. If timer is already active, the elapsed time (since timer was started) is displayed.
			\|-
			\|<code>/Toff</code>
			\|Turn timer off (if active) and display elapsed time (since timer was started).
			\|-
			\|<code>/Result</code><BR><code>Result=</code><var>res</var>
	\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.		\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.
	\|-		\|-

Jw at 08:44, 9 January 2018

2018-01-09T08:44:03Z

← Older revision		Revision as of 10:44, 9 January 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:ConLog - Write messages to the Console and/or the Log-window}}		{{DISPLAYTITLE:ConLog - Write messages to the Console and/or the Log-window}}

	CONLOG [<var>line1</var> [<var>line2</var> ..]] [ <var>options</var> ]		CONLOG [<var>line1</var> [<var>line2</var> ..]] [ <var>options</var> ]
	:Write the specified text-lines (<var>line1</var>, ...) to the [[User_Guide/STX_Console\|Console window]] and/or the [[User_Guide/Log_Window\|Log-window]]. This function can be used by scripts to write error- and progress-information to the Console. It		:Write the specified text-lines (<var>line1</var>, ...) to the [[User_Guide/STX_Console\|Console window]] and/or the [[User_Guide/Log_Window\|Log-window]]. This function can be used by scripts to write error- and progress-information to the Console. It

Toni at 08:03, 27 June 2017

2017-06-27T08:03:32Z

← Older revision		Revision as of 10:03, 27 June 2017
Line 32:		Line 32:
	\|-		\|-
	\|<code>/Progress</code>		\|<code>/Progress</code>
	\|If this option is supplied, all other options are ignored and the text is written to the Console window only. The first line is written with the '''overwrite''' mode, this means the text <var>line1</var> replaces the last output line.		\|If this option is supplied, '''all other options are ignored''' and the text is written to the Console window only. The first line is written with the '''overwrite''' mode, this means the text <var>line1</var> replaces the last output line.
			\|-
			\|<code>/File=</code><var>x</var>
			\|Appends the text lines to the file with path <var>x</var> (opened temporary in text-append mode) or to the fileitem <var>x</var> (if <var>x</var> is the id of a textfileitem)
	\|-		\|-
	!RESULT !!description		!RESULT !!description

Jw at 12:08, 26 June 2017

2017-06-26T12:08:15Z

← Older revision		Revision as of 14:08, 26 June 2017
Line 18:		Line 18:
	\|Write the prefix <code>''appid'':''currtime'' - </code> before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).		\|Write the prefix <code>''appid'':''currtime'' - </code> before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).
	\|-		\|-
	\|<code>/Error</~~var~~>		\|<code>/Error</code>
	\|Write the prefix <code>Error! - </code> before each text line.		\|Write the prefix <code>Error! - </code> before each text line.
	\|-		\|-
	\|<code>/Warning</~~var~~>		\|<code>/Warning</code>
	\|Write the prefix <code>Warning! - </code> before each text line.		\|Write the prefix <code>Warning! - </code> before each text line.
	\|-		\|-

Jw at 12:07, 26 June 2017

2017-06-26T12:07:59Z

← Older revision		Revision as of 14:07, 26 June 2017
Line 12:		Line 12:
	!option !!description !!default		!option !!description !!default
	\|-		\|-
	\|<code>/Noconsole</~~var~~>		\|<code>/Noconsole</code>
	\|Output only to the Log-window and not to the Console window.		\|Output only to the Log-window and not to the Console window.
	\|-		\|-

Toni at 14:44, 1 February 2016

2016-02-01T14:44:12Z

← Older revision		Revision as of 16:44, 1 February 2016
Line 42:		Line 42:

	;See also:		;See also:
	[[../LOGWINDOW\|LogWindow]], [[../UM\|UM and EM]], [[../~~BUtil~~#MsgBox\|MsgBox]]		[[../LOGWINDOW\|LogWindow]], [[../UM\|UM and EM]], [[../BUTIL#MsgBox\|MsgBox]]
	~~<pre>~~
	~~[macro umemtest]~~
	~~um press OK key to continue; UM - 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!~~
	~~conlog '$#mac: you should never see this message - something goes wrong!'~~
	~~exit 1 int 0~~
	~~</pre>~~

Toni at 14:43, 1 February 2016

2016-02-01T14:43:16Z

← Older revision		Revision as of 16:43, 1 February 2016
Line 5:		Line 5:

	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description ~~!!default~~		!argument !!description
	\|-		\|-
	\|<var>line1</var>, <var>line2</var>, ...		\|<var>line1</var>, <var>line2</var>, ...
	\|The text lines to be written to the window(s).		\|The text lines to be written to the window(s).
	\|
	\|-		\|-
	!option !!description !!default		!option !!description !!default
Line 15:		Line 14:
	\|<code>/Noconsole</var>		\|<code>/Noconsole</var>
	\|Output only to the Log-window and not to the Console window.		\|Output only to the Log-window and not to the Console window.
	\|
	\|-		\|-
	\|<code>/Shell</code>		\|<code>/Shell</code>
	\|Write the prefix <code>''appid'':''currtime'' - </code> before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).		\|Write the prefix <code>''appid'':''currtime'' - </code> before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).
	\|
	\|-		\|-
	\|<code>/Error</var>		\|<code>/Error</var>
	\|Write the prefix <code>Error! - </code> before each text line.		\|Write the prefix <code>Error! - </code> before each text line.
	\|
	\|-		\|-
	\|<code>/Warning</var>		\|<code>/Warning</var>
	\|Write the prefix <code>Warning! - </code> before each text line.		\|Write the prefix <code>Warning! - </code> before each text line.
	\|
	\|-		\|-
	\|<code>/X</code><BR><code>/X=</code><var>n		\|<code>/X</code><BR><code>/X=</code><var>n
	\|Exit from <var>n</var> macro levels. If <code>/X</code> (eXit) is supplied without a number, the number of levels <var>n</var> is set to 2 (return to caller).		\|Exit from <var>n</var> macro levels. If <code>/X</code> (eXit) is supplied without a number, the number of levels <var>n</var> is set to 2 (return to caller).
	(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)		(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)
	\|
	\|-		\|-
	\|<code>Result</code><BR><code>Result=</code><var>res</var>		\|<code>Result</code><BR><code>Result=</code><var>res</var>
	\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.		\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.
			\|-
			\|<code>/Progress</code>
			\|If this option is supplied, all other options are ignored and the text is written to the Console window only. The first line is written with the '''overwrite''' mode, this means the text <var>line1</var> replaces the last output line.
	\|-		\|-
	!RESULT !!description		!RESULT !!description
Line 44:		Line 41:
	\|}		\|}

	~~Example~~:		;See also:
			[[../LOGWINDOW\|LogWindow]], [[../UM\|UM and EM]], [[../BUtil#MsgBox\|MsgBox]]
	<pre>		<pre>
	[macro umemtest]		[macro umemtest]

Toni at 14:38, 1 February 2016

2016-02-01T14:38:26Z

← Older revision		Revision as of 16:38, 1 February 2016
Line 18:		Line 18:
	\|-		\|-
	\|<code>/Shell</code>		\|<code>/Shell</code>
	\|Write the prefix <code>"''appid'':''currtime'' - " before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).		\|Write the prefix <code>''appid'':''currtime'' - </code> before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).
	\|		\|
	\|-		\|-
	\|<code>/Error</var>		\|<code>/Error</var>
	\|Write the prefix "Error! - " before each text line.		\|Write the prefix <code>Error! - </code> before each text line.
	\|		\|
	\|-		\|-
	\|<code>/Warning</var>		\|<code>/Warning</var>
	\|Write the prefix "Warning! - " before each text line.		\|Write the prefix <code>Warning! - </code> before each text line.
	\|		\|
	\|-		\|-
	\|<code>/X</code><BR><code>/X=</code><var>n		\|<code>/X</code><BR><code>/X=</code><var>n
	\| Exit from <var>n</var> macro levels. If <code>/X</code> (eXit) is supplied without a number, the number of levels <var>n</var> is set to 2 (return to caller).		\|Exit from <var>n</var> macro levels. If <code>/X</code> (eXit) is supplied without a number, the number of levels <var>n</var> is set to 2 (return to caller).
	(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)		(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)
	\|		\|
	\|-		\|-
	\|<code>Result</code><BR><code>Result=<code><var>res</var>		\|<code>Result</code><BR><code>Result=</code><var>res</var>
	\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.		\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.
	\|-		\|-
	!RESULT !!description		!RESULT !!description
	\|-		\|-
	\|''undefined'' \|\| ~~for the function~~ <code>UM</code>		\|''undefined'' \|\| if <code>/X</code> is not supplied
	\|-		\|-
	\|<var>rc</var> \|\| ~~for the function~~ <code>EM</code> (value is returned to the macro ~~defined b~~< <var>~~level~~</~~var~~>)		\|'<var>res</var>' or <nowiki>''</nowiki> \|\| if <code>/X</code> is supplied; the value is returned to the macro selected by the level <var>n</var> specified with the option <code>/X</code>.
	\|}		\|}

Toni at 14:33, 1 February 2016

2016-02-01T14:33:45Z

← Older revision		Revision as of 16:33, 1 February 2016
Line 12:		Line 12:
	\|-		\|-
	!option !!description !!default		!option !!description !!default
			\|-
			\|<code>/Noconsole</var>
			\|Output only to the Log-window and not to the Console window.
			\|
	\|-		\|-
	\|<code>/Shell</code>		\|<code>/Shell</code>
	\|Write the prefix "''appid'':''currtime'' - " before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).		\|Write the prefix <code>"''appid'':''currtime'' - " before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).
	\|		\|
	-		\|-
	\|<code>/~~Shell~~</var>		\|<code>/Error</var>
	\|Write the prefix "~~''appid'':''currtime''~~ - " before each text line~~. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss)~~.		\|Write the prefix "Error! - " before each text line.
	\|		\|
	~~<code>UM</code> or <code>EM</code>~~
	\|-		\|-
	\|<~~var~~>rc</var>		\|<code>/Warning</var>
	\|~~The return code of~~ the ~~EM function. This must be an integer number~~.		\|Write the prefix "Warning! - " before each text line.
	\|~~<code>-1</code>~~		\|
	\|-		\|-
	\|<code>/X</code><BR><code>/X=</code><var>n		\|<code>/X</code><BR><code>/X=</code><var>n
Line 30:		Line 33:
	(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)		(see command [[Programmer_Guide/Command_Reference/EXIT\|<code>EXIT</code>]] for details)
	\|		\|
			\|-
			\|<code>Result</code><BR><code>Result=<code><var>res</var>
			\|With this option the result value to be returned with the /X option can be specified. If the value <var>res</var> is not supplied, an empty string (<nowiki>''</nowiki>) is returned.
	\|-		\|-
	!RESULT !!description		!RESULT !!description

Toni at 14:00, 1 February 2016

2016-02-01T14:00:13Z

← Older revision		Revision as of 16:00, 1 February 2016
Line 10:		Line 10:
	\|The text lines to be written to the window(s).		\|The text lines to be written to the window(s).
	\|		\|
			\|-
	!option !!description !!default		!option !!description !!default
	\|-		\|-
	\|<code>/Shell</~~var~~>		\|<code>/Shell</code>
	\|Write the prefix "''appid'':''currtime'' - " before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).		\|Write the prefix "''appid'':''currtime'' - " before each text line. Where ''appid'' is the value of variable <code>AppName</code> and ''currtime'' is the current time (hh.mm.ss).
	\|		\|