Write to Text File
- Updated2023-02-17
- 3 minute(s) read
Write to Text File
Writes a string or an array of strings as lines to a file.
Inputs/Outputs
prompt
Custom message in the title bar of the file dialog box that appears when you do not wire a value to the input path.
file path
The file to which you want to write data.
This input can be a reference to a file or an absolute file path. In both cases, the node creates the specified file if it does not already exist. The node opens the specified file without requiring you to call Open/Create/Replace File first.
text
String or array of strings that this node writes to a file.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
refnum out
A reference to the file that this node uses.
cancelled?
A Boolean value that indicates whether the user cancelled the dialog box that appears if no input file was wired to this node.
| True | The dialog box was cancelled. |
| False | The dialog box was not cancelled, or the dialog box did not appear. |
error out
Error information.
The node produces this output according to standard error behavior.
Programming Patterns
Adding End-of-Line Characters to an Array
This node appends platform-dependent, end-of-line (EOL) characters to the elements of an array even if you right-click the function and remove the checkmark next to the Convert EOL shortcut menu item.
Where Does This Node Start Writing?
If you wire a path to this node, the node opens or creates the file before writing to it and replaces any previous file contents. If you wire a reference to this node, the node begins writing at the current file position.
Permissions for Write to Text File
Use the Set File Position node if you need to perform random access file reads or writes.