FileWrite Function

Format

b = filewrite(file_handler, messageʃ, argument1, ..., argumentNʅ);

Description

The filewrite function writes one or more lines of text to the File associated with file_handler.

The message is either a string expression or a numeric message number that contains the text that is written to the file. If the text contains any message formatters, the optional arguments argument1 to argumentN will be inserted into the text. There are some additional options for file output:

If you want to break a line of text into two lines, place '\n' (newline) where you want the line divided.
If you want a text line to begin on a new page, place '\f' (form feed) at the beginning of the text string.
If using the Original logic version, to output \n or \f as text instead of a new line or a new page, use a double backslash (e.g., "\\n").

Alternatively, the message can be a string List. If a List is provided, then each string contained in the List is written to the file, allowing for the output of multiple lines of text with one function call.

File text can also be written using the File.writeText and File.writeLines actions.

Return Value

The function returns a logical value of 1 (true) if successful and 0 (false) otherwise.

Example

PROC GLOBAL

File CsvFile;

PROC EXAMPLE

filewrite(CsvFile, "Name,Sex,Age");

do numeric counter = 1 while counter <= totocc(PERSON_REC)
filewrite(CsvFile, "%s,%d,%d", encode(CSV, NAME(counter)), SEX(counter), AGE(counter));
enddo;