Programmer Guide/Command Reference/WRITELOG: Difference between revisions

From STX Wiki
Jump to navigationJump to search
(initial import)
 
No edit summary
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
====WRITELOG====


<code>WRITELOG <var>text</var> [/Newline ... /Newline]</code>
This command writes a line of text to the [[User Guide/Log_Window|Log-window]].


<code>WRITELOG <var>format args</var> /Format [/Newline ... /Newline]</code>
WRITELOG <var>text</var> [/Newline &hellip; /Newline] [/Clear]
:Write <var>text</var> to the Log-window.
WRITELOG <var>format</var> <var>args</var> /Format [/Newline &hellip; /Newline] [/Clear]
:Write a formatted text composed by the specified [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|format string]] <var>format</var> and the arguments <var>args</var>.


Write a line to the log window. Use /Clear to empty the log window before text is written. Format strings are described in the topic Format Strings and Rules. The arguments are the same as for the <code>WRITE</code> command. Instead of this command the macros <code>LOGMSG</code> or <code>BUTIL LOGMSG</code> can be called, which append some useful information to the text (e.g. application name, date/time, ...).
;Options:
:*<code>/Format</code>: mandatory option to write formatted text
:*<code>/Clear</code>: clear the Log-window before writing text
:*<code>/Newline</code>: each /N adds an empty line after the written text
 
;Note:The output starts always at the begin of the next line. Its not possible to overwrite lines or to append text to the last line.
 
;See also:macros [[Programmer_Guide/Macro_Library/LOGWINDOW|<code>LogWindow</code>]], [[Programmer_Guide/Macro_Library/CONLOG|<code>ConLog</code>]], [[Programmer_Guide/Macro_Library/BUTIL#MsgBox|<code>BUtil MsgBox</code>]], [[Programmer_Guide/Macro_Library/UM|<code>UM</code> and <code>EM</code>]]

Latest revision as of 16:32, 1 February 2016


This command writes a line of text to the Log-window. 

WRITELOG text [/Newline … /Newline] [/Clear]
Write text to the Log-window.
WRITELOG format args /Format [/Newline … /Newline] [/Clear]
Write a formatted text composed by the specified format string format and the arguments args.
Options
  • /Format: mandatory option to write formatted text
  • /Clear: clear the Log-window before writing text
  • /Newline: each /N adds an empty line after the written text
Note
The output starts always at the begin of the next line. Its not possible to overwrite lines or to append text to the last line.
See also
macros LogWindow, ConLog, BUtil MsgBox, UM and EM
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Command_Reference/WRITELOG&oldid=8917"

Navigation menu

Personal tools