Difference between revisions of "FILETOSTR()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to read a file into a text string  
 
Function to read a file into a text string  
 
  
 
==Syntax==
 
==Syntax==
 
FILETOSTR(<expC>)
 
FILETOSTR(<expC>)
 
  
 
==See Also==
 
==See Also==
[[AT()]], [[ATNEXT()]], [[FCLOSE()]], [[FCREATE()]], [[FERROR()]], [[FGETS()]], [[FOPEN()]], [[FPUTS()]], [[FREAD()]], [[FREADSTR()]], [[FWRITE()]], [[MEMOREAD()]], [[MEMOWRITE()]], [[SET STRESCAPE]], [[STUFF()]], [[STR()]], [[STREXTRACT()]], [[STRTOFILE()]], [[STRTRAN()]], [[STRZERO()]], [[SUBSTR()]], [[TEXTEDIT()]], [[TRIM()]]
+
[[AT()]], [[ATNEXT()]], [[FCLOSE()]], [[FCREATE()]], [[FERROR()]], [[FGETS()]], [[FOPEN()]], [[FPUTS()]], [[FREAD()]], [[FREADSTR()]], [[FWRITE()]], [[MEMOREAD()]], [[MEMOWRITE()]], [[SET STRESCAPE]], [[STUFF()]], [[STR()]], [[STREXTRACT()]], [[STRTOFILE()]], [[STRTRAN()]], [[STRZERO()]], [[SUBSTR()]], [[TRIM()]]
 
+
  
 
==Description==
 
==Description==
 
The FILETOSTR() function reads the specified file and returns its contents as text.
 
The FILETOSTR() function reads the specified file and returns its contents as text.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 21: Line 17:
 
|-
 
|-
 
|}
 
|}
 
  
 
==Example==
 
==Example==
Line 28: Line 23:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:String Data]]
 
[[Category:String Data]]
 
[[Category:String Data Functions]]
 
[[Category:String Data Functions]]

Revision as of 06:36, 10 February 2012

Purpose

Function to read a file into a text string

Syntax

FILETOSTR(<expC>)

See Also

AT(), ATNEXT(), FCLOSE(), FCREATE(), FERROR(), FGETS(), FOPEN(), FPUTS(), FREAD(), FREADSTR(), FWRITE(), MEMOREAD(), MEMOWRITE(), SET STRESCAPE, STUFF(), STR(), STREXTRACT(), STRTOFILE(), STRTRAN(), STRZERO(), SUBSTR(), TRIM()

Description

The FILETOSTR() function reads the specified file and returns its contents as text.

Parameter Description
<expC> Name of the file to be read. This should include the path if not in the current directory.

Example

myString = filetostr("myfile.txt")