18 lines
376 B
Markdown
18 lines
376 B
Markdown
|
# file_Read
|
||
|
|
Open a file and return the contents in `r` mode.
|
||
|
|
|
||
|
|
## Arguments
|
||
|
|
- path (string): Path to the file you want to read
|
||
|
|
|
||
|
|
## Returns
|
||
|
|
- content (string): Contents of the file
|
||
|
|
|
||
|
|
## Raises
|
||
|
|
- `FileError`: Raised if the file doesn't exist or there was an error allocating memory for the file
|
||
|
|
|
||
|
|
## Example
|
||
|
|
```python
|
||
|
|
call !file_Read "my_file.txt" &contents
|
||
|
|
println $contents
|
||
|
|
```
|