loadTextFile: Difference between revisions

Revision as of 01:18, 3 December 2020

Function Server and Client 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.

1)	string	filePath	The path to the file.

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

There aren't any notes for this function.

There aren't any examples for this function.

There isn't any compatibility information for this function.

@@ Line 6: / Line 6: @@
 |parameter1 = string filePath The path to the file.
 |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
 |returnFail1 = null n/a
 }}