Programmer Guide/Macro Library/CONLOG: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
{|class="einrahmen" | {|class="einrahmen" | ||
!argument !!description | !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: | ||
|} | |} | ||
;See also: | |||
[[../LOGWINDOW|LogWindow]], [[../UM|UM and EM]], [[../BUtil#MsgBox|MsgBox]] | |||
<pre> | <pre> | ||
[macro umemtest] | [macro umemtest] | ||
Revision as of 15:43, 1 February 2016
CONLOG [line1 [line2 ..]] [ options ]
- Write the specified text-lines (line1, ...) to the Console window and/or the Log-window. This function can be used by scripts to write error- and progress-information to the Console. It
| argument | description | |
|---|---|---|
| line1, line2, ... | The text lines to be written to the window(s). | |
| option | description | default |
/Noconsole
|
Output only to the Log-window and not to the Console window. | |
/Shell
|
Write the prefix appid:currtime - before each text line. Where appid is the value of variable AppName and currtime is the current time (hh.mm.ss).
| |
/Error
|
Write the prefix Error! - before each text line.
| |
/Warning
|
Write the prefix Warning! - before each text line.
| |
/X/X=n
|
Exit from n macro levels. If /X (eXit) is supplied without a number, the number of levels n is set to 2 (return to caller).
(see command | |
ResultResult=res
|
With this option the result value to be returned with the /X option can be specified. If the value res is not supplied, an empty string ('') is returned. | |
/Progress
|
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 line1 replaces the last output line. | |
| RESULT | description | |
| undefined | if /X is not supplied
| |
| 'res' or '' | if /X is supplied; the value is returned to the macro selected by the level n specified with the option /X.
|
- See also
[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
