loadTextFile: Difference between revisions

Revision as of 18:12, 14 May 2023

Function Server and Client Online and Offline

Available since Server 1.2.1, Client 1.2.1

string loadTextFile(string filePath)

The loadTextFile function is used to fetch all text inside a file as a string, or null if there was a failure.

1)	string	filePath	The path to the file.

string	The text fetched, as a string, which could be an empty string if the file is blank, or null if a failure occurred (e.g. if the file was not found, or the file can't be opened).

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 7: / Line 7: @@
 |parameter1 = string filePath The path to the file.
 |returnTypes = string
-|usage = fetch all text inside a file as a string
+|usage = fetch all text inside a file as a string, or null if there was a failure
-|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 if the file is blank, or null if a failure occurred (e.g. if the file was not found, or the file can't be opened)
 |returnFail1 = null n/a
 }}