Programmer Guide/Command Reference/WRITELOG: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
WRITELOG <var>format</var> <var>args</var> /Format [/Newline … /Newline] | WRITELOG <var>format</var> <var>args</var> /Format [/Newline … /Newline] | ||
Write a line to the log window. Use <code>/Clear</code> to empty the log window before text is written. Format strings are described in the topic [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|Format Strings and Rules]]. | Write a line to the log window. 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 the topic [[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. | |||
Instead of the <code>WRITELOG</code> command, you may use the macros <code>[[Programmer Guide/Command Reference/LOGMSG|LOGMSG]]</code> 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). | |||
Revision as of 14:59, 15 April 2014
WRITELOG text [/Newline … /Newline] WRITELOG format args /Format [/Newline … /Newline]
Write a line to the log window. Use /Clear to empty the log window before text is written.
Format strings (the format when using the /Format option) are described in the topic Format Strings and Rules.
Generally, the arguments to the WRITELOG command are the same as for the WRITE command. Refer to the WRITE documentation for more details.
Instead of the WRITELOG command, you may use the macros LOGMSG or BUTIL LOGMSG, which append some useful information to the text (e.g. the application nameand the date and time of emitting the message).
