Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
→file:read-text
|-
| '''Summary'''
|Reads the textual contents of the file specified by {{Code|$path}} and returns it as streamable {{Code|xs:string}}.<br />The optional parameter {{Code|$encoding}} defines the encoding of the file.<br />
|-
| '''Errors'''
|{{Error|FILE0001|#Errors}} the specified file does not exist.<br />{{Error|FILE0004|#Errors}} the specified path is a directory.<br />{{Error|FILE0005|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|FILE9999|#Errors}} the operation fails for some other reason.<br />
|-
| '''Examples'''
|
* <code><nowiki>data(file:read-rext("config.txt"))</nowiki></code> returns a materialized representation of the streamable result.
|}
