loadTextFile

Revision as of 04:55, 2 December 2020 by Mex (talk | contribs) (Created page with "{{ScriptItem |endpoint = shared |type = function |name = loadTextFile |parameters = string filePath |parameter1 = string filePath The path to the file. |returnTypes = string |...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Function Server and Client icon-iii.png icon-vc.png icon-sa.png icon-iv.png Online and Offline

Available since Server 1.0.0, Client 1.0.0

string loadTextFile(string filePath)

The loadTextFile function is used to fetch all text inside a file.
The file and data returned may contain new-line character(s).
The data fetched is either up to the EOF (end of file) or first null-byte (\0) character, whichever occurs first.
This function internally opens, reads, and closes the file.
The file is opened in text-mode, not binary-mode.

Parameters

1) string filePath The path to the file.

Return

string The data fetched, as a string, which could be an empty string.

Notes

There aren't any notes for this function.

Examples

There aren't any examples for this function.

Compatibility

There isn't any compatibility information for this function.

Related

Server Related

        createFile
        fileExists
        loadTextFile
        openFile
        saveTextFile


Client Related

        createFile
        fileExists
        loadTextFile
        openFile
        saveTextFile