Difference between revisions of "API File"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
File reading and writing operations | File reading and writing operations | ||
| − | ===Functions provided for this class | + | ==Sub-classes provided for this class== |
| − | {||-|[[API File.AbsPath|AbsPath]]|Gets an absolute path from a relative filename|-|[[API File.RelPath|RelPath]]|Gets an relative path from an absolute filename|-|[[API File.CreateDir|CreateDir]]|Creates a directory structure|-|[[API File.GetType|GetType]]|Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk|-|[[API File.GetSize|GetSize]]|Gets the number of bytes in the file, by handle or name|-|[[API File.Delete|Delete]]|Deletes the file or directory structure|-|[[API File.Create|Create]]|Creates the new file as a standard stream|-|[[API File.Open|Open]]|Opens the existing file as a standard stream|-|[[API File.ReadArray|ReadArray]]|Reads an array from the file, returns elements read|-|[[API File.WriteArray|WriteArray]]|Writes an array to the file|-|[[API File.SetPos|SetPos]]|Sets the position of the next read or write in the file|-|[[API File.GetPos|GetPos]]|Gets the position of the next read or write in the file|-|[[API File.Flush|Flush]]|Writes all unwritten data to the file in one block | + | {| |
| + | |- | ||
| + | |width="35%"|[[API File.Buffer|Buffer]] | ||
| + | |Reads writes and monitors circular buffers | ||
| + | |- | ||
| + | |width="35%"|[[API File.NVM|NVM]] | ||
| + | |Reads from a file as though a block of NVM | ||
| + | |} | ||
| + | |||
| + | |||
| + | ==Functions provided for this class== | ||
| + | {| | ||
| + | |- | ||
| + | |width="35%"|[[API File.AbsPath|AbsPath]] | ||
| + | |Gets an absolute path from a relative filename | ||
| + | |- | ||
| + | |width="35%"|[[API File.RelPath|RelPath]] | ||
| + | |Gets an relative path from an absolute filename | ||
| + | |- | ||
| + | |width="35%"|[[API File.CreateDir|CreateDir]] | ||
| + | |Creates a directory structure | ||
| + | |- | ||
| + | |width="35%"|[[API File.GetType|GetType]] | ||
| + | |Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk | ||
| + | |- | ||
| + | |width="35%"|[[API File.GetSize|GetSize]] | ||
| + | |Gets the number of bytes in the file, by handle or name | ||
| + | |- | ||
| + | |width="35%"|[[API File.Delete|Delete]] | ||
| + | |Deletes the file or directory structure | ||
| + | |- | ||
| + | |width="35%"|[[API File.Create|Create]] | ||
| + | |Creates the new file as a standard stream | ||
| + | |- | ||
| + | |width="35%"|[[API File.Open|Open]] | ||
| + | |Opens the existing file as a standard stream | ||
| + | |- | ||
| + | |width="35%"|[[API File.ReadArray|ReadArray]] | ||
| + | |Reads an array from the file, returns elements read | ||
| + | |- | ||
| + | |width="35%"|[[API File.WriteArray|WriteArray]] | ||
| + | |Writes an array to the file | ||
| + | |- | ||
| + | |width="35%"|[[API File.SetPos|SetPos]] | ||
| + | |Sets the position of the next read or write in the file | ||
| + | |- | ||
| + | |width="35%"|[[API File.GetPos|GetPos]] | ||
| + | |Gets the position of the next read or write in the file | ||
| + | |- | ||
| + | |width="35%"|[[API File.Flush|Flush]] | ||
| + | |Writes all unwritten data to the file in one block | ||
| + | |} | ||
| − | + | ||
| − | {| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Seek_Begin|0 | + | ==Constants provided for this class== |
| − | |-LONG|Seek_Curr|1 | + | {| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|- |
| − | |-LONG|Seek_End|2 | + | |LONG |
| + | |Seek_Begin|0 | ||
| + | |- | ||
| + | |LONG | ||
| + | |Seek_Curr|1 | ||
| + | |- | ||
| + | |LONG | ||
| + | |Seek_End|2 | ||
|} | |} | ||
| − | + | ||
| + | ==Examples== | ||
| + | ''No examples available'' | ||
Revision as of 21:13, 11 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
| LONG | 0 |
| LONG | 1 |
| LONG | 2 |
Examples
No examples available
