You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Writes a string of characters or an array of strings as lines to a file. If you wire a path to the file input, the function opens or creates the file before writing to it and replaces any previous file contents. If you wire a file refnum to the file input, writing begins at the current file position. To append to an existing file, set the file position to the end of the file by using the Set File Position function. This function does not work for files inside an LLB.

Use the Set File Position function if you need to perform random access.

Details  Example

	prompt is the message that appears above the list of files and directories or folder in the file dialog box.
	file can be a refnum or absolute file path. If the file is a path, this function opens the file specified by the path. This function creates the specified file if it does not already exist. The default is to display a file dialog box and prompt you to select a file. If you specify an empty or relative path, this function returns an error.
	text is the data the function writes to the file. text is a string or an array of strings. This function always appends platform-dependent end-of-line characters to the elements of an array regardless of whether you select Convert EOL from the drop-down menu that appears when you right-click the VI.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	refnum out is the refnum of the file that the function read. You can wire this output to another file function, depending on what you want to do with the file. The default is to close the file if it is referenced by a file path or selected from the file dialog box. If file is a refnum or if you wire refnum out to another function, LabVIEW assumes that the file is still in use until you close it.
	cancelled is TRUE if you cancel the dialog box.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Write to Text File Details

This function converts all end-of-line characters to platform-dependent end-of-line characters unless you right-click the function and remove the checkmark next to the Convert EOL shortcut menu item.

Example

Refer to the Write-Read Text File VI in the labview\examples\general\functions\File IO directory for an example of using the Write to Text File function.