Programmer Guide/Command Reference/WRITELOG: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 5: Line 5:
  WRITELOG [/Newline &hellip; /Newline] [[Programmer_Guide/Command_Reference_Options/-|/-]] <var>file</var> <var>text</var>
  WRITELOG [/Newline &hellip; /Newline] [[Programmer_Guide/Command_Reference_Options/-|/-]] <var>file</var> <var>text</var>
  WRITELOG /Format [/Newline &hellip; /Newline] [[Programmer_Guide/Command_Reference_Options/-|/-]] <var>file</var> <var>format</var> <var>args</var>
  WRITELOG /Format [/Newline &hellip; /Newline] [[Programmer_Guide/Command_Reference_Options/-|/-]] <var>file</var> <var>format</var> <var>args</var>
This {{Stx}} command writes a line of text to the [[User Guide/Log|log window]] (the tiny baby window you normally wonder what it is good for). Use <code>/Clear</code> to empty the log window before text is written.
This {{Stx}} command writes a line of text to the [[User Guide/Log|log window]] (the tiny baby window you normally wonder what it is good for). Use <code>/Clear</code> to empty the log window before text is written.


Format strings (the <code>format</code> when using the <code>/Format</code> option) are described in [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|Format Strings and Rules]].
Format strings (the <code>format</code> when using the <code>/Format</code> option) are described in [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|Format Strings and Rules]].


Generally, the arguments to the <code>WRITELOG</code> command are the same as for the <code>[[Programmer_Guide/Command_Reference/WRITE|WRITE]]</code> command. Refer to the <code>[[Programmer_Guide/Command_Reference/WRITE|WRITE]]</code> documentation for more details.
;See also:
 
[[Programmer Guide/Macro Reference/CONLOG|macro <code>ConLog</code>]],
Instead of the <code>WRITELOG</code> command, you may use the macros <code>[[Programmer Guide/Command Reference/LOGMSG|LOGMSG]]</code> (believe me - there is no such command in the whole {{Stx}} source&hellip;) or <code>[[Programmer_Guide/Macro_Library/BUTIL#LOGMSG|BUTIL LOGMSG]]</code>, which append some useful information to the text (e.g. the application nameand the date and time of emitting the message).
[[Programmer Guide/Macro Reference/BUTIL#MsgBox|macro <code>BUtil MsgBox</code>]],
 
[[Programmer_Guide/Macro_Library/UM|macros <code>UM</code> and <code>EM</code>]]
If you want to show your message more interactively (i.e., in a dialog box), you may consider the {{STx}} functions [[Programmer_Guide/Macro_Library/StdLib#UM_and_EM|<code>UM</code> and <code>EM</code>]].

Revision as of 16:13, 1 February 2016

WRITELOG text [/Newline … /Newline]
WRITELOG format args /Format [/Newline … /Newline]

WRITELOG [/Newline … /Newline] /- file text
WRITELOG /Format [/Newline … /Newline] /- file format args

This STx command writes a line of text to the log window (the tiny baby window you normally wonder what it is good for). Use /Clear to empty the log window before text is written.

Format strings (the format when using the /Format option) are described in Format Strings and Rules.

See also

macro ConLog, macro BUtil MsgBox, macros UM and EM

Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Command_Reference/WRITELOG&oldid=8908"

Navigation menu

Personal tools