Programmer Guide/Macro Library/CONLOG: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
|- | |- | ||
|<code>/Shell</code> | |<code>/Shell</code> | ||
|Write the prefix <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). | ||
| | | | ||
|- | |- | ||
|<code>/Error</var> | |<code>/Error</var> | ||
|Write the prefix | |Write the prefix <code>Error! - </code> before each text line. | ||
| | | | ||
|- | |- | ||
|<code>/Warning</var> | |<code>/Warning</var> | ||
|Write the prefix | |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'' || | |''undefined'' || if <code>/X</code> is not supplied | ||
|- | |- | ||
|<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>. | ||
|} | |} | ||
Revision as of 15:38, 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 | default |
|---|---|---|
| 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. | |
| 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.
|
Example:
[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
