fileOpen
Syntax | fileOpen(path_to_file, mode) | Package | file |
Alias |
| Pkg Usage | open(path_to_file, mode) |
Description
Opens a file in memory so that it may be read from. Note that the file is seen as an octet stream, encoding doesn’t matter from this point of view. File may be read and written at random locations.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
path_to_file | String | Yes | Specifies the path to the file that should be opened. |
mode | Boolean | Yes | If 'true' the file will be opened in read only mode. If 'false' the file will be editable. |
Return Type
Integer
The id of the file that was opened. The id has no meaning beyond the script.
Error Handling
Throws String
Errors:
"invalid": if the path is invalid
"cannot_work_on_directory": if the path is a directory, in fact, and not a file
"unresolvable": if the file cannot be resolved
"notfound": if the file is not found
Example
Example 1
use "file";
int fid = open(filename); //fileOpen
fileClose(fid);//full name of the functionSee also
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.