loadTextFile: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
|parameter1 = string filePath The path to the file.
|parameter1 = string filePath The path to the file.
|returnTypes = string
|returnTypes = string
|usage = fetch all text inside a file.<br>The file and text returned may contain new-line character(s).<br>The text fetched is either up to the EOF (end of file) or first null-byte (\0) character, whichever occurs first.<br>This function internally opens, reads, and closes the file.<br>The file is internally opened in text-mode, not binary-mode.<br>The file is internally opened in read-mode, not write-mode.
|usage = fetch all text inside a file as a string
|returnInfo = the text fetched, as a string, which could be an empty string
|returnInfo = the text fetched, as a string, which could be an empty string
|returnFail1 = null n/a
|returnFail1 = null n/a
}}
}}

Revision as of 01:18, 3 December 2020

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 as a string.

Parameters

1) string filePath The path to the file.

Return

string The text 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

icon-iii.png icon-vc.png icon-sa.png icon-iv.png createFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png fileExists
icon-iii.png icon-vc.png icon-sa.png icon-iv.png loadTextFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png openFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png saveTextFile


Client Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png createFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png fileExists
icon-iii.png icon-vc.png icon-sa.png icon-iv.png loadTextFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png openFile
icon-iii.png icon-vc.png icon-sa.png icon-iv.png saveTextFile