printInFile

Availability

This routine is available starting with katl-commons 1.0.

Syntax

printInFile(filepath, var[, charset][, boolean])

Description

Prints in the specified file the provided value. It appends the value to the file. For best results, use absolute paths, since relative paths are resolved starting with the current working directory.

Parameters

Parameter name

Type

Required

Description

filepath

string

Yes

Specifies the file name to write in.

var

string

Yes

Specifies the character expression to write into the file filepath.

charsetstringNo

Specifies the charset used to write that file.
Available starting with katl-commons 4.0.0.

booleanbooleanNo'true' if new line is added after character expression is added to file, otherwise 'false'. Defaults to 'true'
Available starting with katl-commons 4.8.0.16.

Return type

Empty value. The returned value has no meaning.

Example

printInFile("C:/story.txt", "Once upon a time...");

Prints to the story.txt file the record Once upon a time...

Notes

It is recommended that you use forward slashes ( / ) for file paths. As a general observation use the silEnv() routine to create an absolute path.

See also