Difference between revisions of "API File"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
 
File reading and writing operations
 
File reading and writing operations
  
===Functions 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|-|[[API File.Buffer|Buffer]]|Reads writes and monitors circular buffers|-|[[API File.NVM|NVM]]|Reads from a file as though a block of NVM|}
 
  
===Constants provided for this class===
+
__TOC__
{| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Seek_Begin|0
+
 
|-LONG|Seek_Curr|1
+
==Sub-classes provided for this class==
|-LONG|Seek_End|2
+
{|
 +
|-
 +
|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
 
|}
 
|}
  
===Examples===
+
 
 +
==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
 +
|}
 +
 
 +
 
 +
==Constants provided for this class==
 +
{| class="wikitable" width="85%"
 +
|+ Used by [[API File.SetPos|SetPos]]()
 +
|-
 +
!width="10%"|Type
 +
!width="20%"|Name
 +
!width="20%"|Value
 +
!width="60%"|Description
 +
|-
 +
|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==
 +
''<span style="color:red;">No additional examples</span>''
 +
 
 +
==See also==
 +
''<span style="color:red;">No additional information</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> File reading and writing operations


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

Used by SetPos()
Type Name Value Description
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 examples

See also

No additional information