Programmer Guide/Command Reference/WRITE: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
WRITE <var>file</var> <var>text</var> [/Newline … /Newline] | |||
WRITE <var>file</var> <var>format</var> <var>args</var> /Format [/Newline … /Newline] | |||
This {{Stx}} command writes (hence its name) text into a file connected to a file item. If ''no'' <code>/Newline</code> option is specified, the text of the next <code>WRITE</code> command will be placed in the same line. Format strings are described in [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|Format Strings and Rules]]. | |||
;<var>file</var> | ;<var>file</var> | ||
:The name of a file item (must, obviously, be open for write access). | |||
:The name of a file item ( | |||
;<var>text</var> | ;<var>text</var> | ||
:The output text (unformatted, written "as is"). | :The output text (unformatted, written "as is"). | ||
;<var>format</var> | ;<var>format</var> | ||
:The format string (see [[Programmer_Guide/General_Descriptions/Format_Strings_and_Rules|Format Strings and Rules]]). There ''must'' be a corresponding <var>args</var> argument for each "% format" tag in <var>format</var> because{{Stx}} will not check if the number of arguments supplied matches the given <var>format</var> string and will, hence, crash heavily if there is any mistake. | |||
:The format string (see Format Strings and Rules). | |||
;<var>args</var> | ;<var>args</var> | ||
:The arguments (one for each format tag in <var>format</var>). Note that {{STx}} will not check if the number of arguments supplied matches the given <var>format</var> string and will, hence, crash heavily if there is any mistake. | |||
== Example == | |||
'' | #f := $([[Programmer_Guide/Shell_Items/File/NEW_FILE|new file]] * test.txt /T /W)WRITE $#f 'this is %d format for %3.0f numbers' 1 0.2*10 /Newline /Format | ||
< | The line "<code>this is 1 format for 2 numbers</code>" will be written to the file. Note that this is also an example of horribly bad programming style, not checking if the inline [[Programmer_Guide/Shell_Items/File/NEW_FILE|<code>NEW FILE</code>]] command succeeded, and happily executing garbage when it did not. | ||
</ | |||
Revision as of 13:53, 8 May 2014
WRITE file text [/Newline … /Newline] WRITE file format args /Format [/Newline … /Newline]
This STx command writes (hence its name) text into a file connected to a file item. If no /Newline option is specified, the text of the next WRITE command will be placed in the same line. Format strings are described in Format Strings and Rules.
- file
- The name of a file item (must, obviously, be open for write access).
- text
- The output text (unformatted, written "as is").
- format
- The format string (see Format Strings and Rules). There must be a corresponding args argument for each "% format" tag in format becauseSTx will not check if the number of arguments supplied matches the given format string and will, hence, crash heavily if there is any mistake.
- args
- The arguments (one for each format tag in format). Note that STx will not check if the number of arguments supplied matches the given format string and will, hence, crash heavily if there is any mistake.
Example
#f := $(new file * test.txt /T /W)WRITE $#f 'this is %d format for %3.0f numbers' 1 0.2*10 /Newline /Format
The line "this is 1 format for 2 numbers" will be written to the file. Note that this is also an example of horribly bad programming style, not checking if the inline NEW FILE command succeeded, and happily executing garbage when it did not.
