Difference between revisions of "API File"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 60: | Line 60: | ||
==Constants provided for this class== | ==Constants provided for this class== | ||
| − | {| class="wikitable" | + | {| class="wikitable" width="85%" |
|- | |- | ||
| − | !width=" | + | !width="15%"|Type |
| − | !width=" | + | !width="25%"|Name |
| − | !width=" | + | !width="20%"|Value |
| + | !width="50%"|Value | ||
|- | |- | ||
|LONG | |LONG | ||
|Seek_Begin | |Seek_Begin | ||
|0 | |0 | ||
| + | |Position offset is an absolute value | ||
|- | |- | ||
|LONG | |LONG | ||
|Seek_Curr | |Seek_Curr | ||
|1 | |1 | ||
| + | |Position offset is relative to the current read/write position | ||
|- | |- | ||
|LONG | |LONG | ||
|Seek_End | |Seek_End | ||
|2 | |2 | ||
| + | |Position offset is relative to the end of the file | ||
|} | |} | ||
Revision as of 21:24, 12 May 2013
<sidebar>API contents</sidebar> File reading and writing operations
Contents
Sub-classes provided for this class
| Buffer | Reads writes and monitors circular buffers |
| NVM | Reads from a file as though a block of NVM |
Functions provided for this class
| AbsPath | Gets an absolute path from a relative filename |
| RelPath | Gets an relative path from an absolute filename |
| CreateDir | Creates a directory structure |
| GetType | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk |
| GetSize | Gets the number of bytes in the file, by handle or name |
| Delete | Deletes the file or directory structure |
| Create | Creates the new file as a standard stream |
| Open | Opens the existing file as a standard stream |
| ReadArray | Reads an array from the file, returns elements read |
| WriteArray | Writes an array to the file |
| SetPos | Sets the position of the next read or write in the file |
| GetPos | Gets the position of the next read or write in the file |
| Flush | Writes all unwritten data to the file in one block |
Constants provided for this class
| Type | Name | Value | Value |
|---|---|---|---|
| LONG | Seek_Begin | 0 | Position offset is an absolute value |
| LONG | Seek_Curr | 1 | Position offset is relative to the current read/write position |
| LONG | Seek_End | 2 | Position offset is relative to the end of the file |
Examples
No additional information
See also
No additional information