Component: File (RPI) (File): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd.
Version	2.7
Category	File

File (RPI) component

File component allowing access to read and write files on the Raspberry Pi file system.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_File_RPI.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_File_RPI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

AppendByteToFile

	AppendByteToFile

- BYTE	Data

- BYTE	Return

AppendStringToFile

	AppendStringToFile

- STRING	Data_String

- BYTE	Return

CloseFile

	CloseFile

- VOID	Return

CreateFile

	CreateFile

- STRING	Filename

- BYTE	Return

DeleteFile

	DeleteFile

- STRING	Filename

- BYTE	Return

MoveToNextFileSector

	MoveToNextFileSector
Not currently implemented on the RPI
- BYTE	ForceNextSector

- BYTE	Return

OpenFile

	OpenFile
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success.
- STRING	Filename
8.3 filename of the file we are trying to open e.g. "file.txt"
- BYTE	Return

OpenFolder

	OpenFolder

- STRING	Folder_Name

- BYTE	Return

ReadByteFromFile

	ReadByteFromFile
Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file).
- BYTE	Return

ReadByteFromIndex

	ReadByteFromIndex
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.
- ULONG	Address

- BYTE	Return

ReadFileLength

	ReadFileLength
Not currently implemented on the RPI
- INT	Return

ReadFileSize

	ReadFileSize
Reads the entire size of the current file in bytes.
- ULONG	Return

ReadStringFromFile

	ReadStringFromFile
Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached.
- UINT	NumBytes
Maximum number of bytes to attempt to read
- BYTE	EndChar
Ends the string if the value specified is found, default is 0
- STRING	Return

SetFileIndex

	SetFileIndex

- BYTE	File_Index
Range: 0 to 4
- VOID	Return

WriteByteToBuffer

	WriteByteToBuffer
Not currently implemented on the RPI
- UINT	Address

- BYTE	Data

- VOID	Return

WriteFileSector

	WriteFileSector
Not currently implemented on the RPI
- BYTE	Return

Property reference

	Properties
	Root Folder
Root location on the RPI where the files will be stored
	File Count
Number of simultaneous files we want to access.
	Simulation
	Sim Root Folder

@@ Line 64: / Line 64: @@
 ===AppendByteToFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AppendByteToFile'''
+| width="90%" class="mtx-class-macrohead" | '''AppendByteToFile'''
 |-
 | colspan="2" | &nbsp;
@@ Line 83: / Line 83: @@
 ===AppendStringToFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AppendStringToFile'''
+| width="90%" class="mtx-class-macrohead" | '''AppendStringToFile'''
 |-
 | colspan="2" | &nbsp;
@@ Line 102: / Line 102: @@
 ===CloseFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CloseFile'''
+| width="90%" class="mtx-class-macrohead" | '''CloseFile'''
 |-
 | colspan="2" | &nbsp;
@@ Line 116: / Line 116: @@
 ===CreateFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateFile'''
+| width="90%" class="mtx-class-macrohead" | '''CreateFile'''
 |-
 | colspan="2" | &nbsp;
@@ Line 135: / Line 135: @@
 ===DeleteFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DeleteFile'''
+| width="90%" class="mtx-class-macrohead" | '''DeleteFile'''
 |-
 | colspan="2" | &nbsp;
@@ Line 154: / Line 154: @@
 ===MoveToNextFileSector===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MoveToNextFileSector'''
+| width="90%" class="mtx-class-macrohead" | '''MoveToNextFileSector'''
 |-
 | colspan="2" | Not currently implemented on the RPI&nbsp;
@@ Line 173: / Line 173: @@
 ===OpenFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OpenFile'''
+| width="90%" class="mtx-class-macrohead" | '''OpenFile'''
 |-
 | colspan="2" | Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success.&nbsp;
@@ Line 192: / Line 192: @@
 ===OpenFolder===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OpenFolder'''
+| width="90%" class="mtx-class-macrohead" | '''OpenFolder'''
 |-
 | colspan="2" | &nbsp;
@@ Line 211: / Line 211: @@
 ===ReadByteFromFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByteFromFile'''
+| width="90%" class="mtx-class-macrohead" | '''ReadByteFromFile'''
 |-
 | colspan="2" | Reads a byte from the currently open file. Auto increments the position in the file. A return value of 0 may signify the end of the file has been reached (depending on the contents of the file).&nbsp;
@@ Line 225: / Line 225: @@
 ===ReadByteFromIndex===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByteFromIndex'''
+| width="90%" class="mtx-class-macrohead" | '''ReadByteFromIndex'''
 |-
 | colspan="2" | Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer. &nbsp;
@@ Line 244: / Line 244: @@
 ===ReadFileLength===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFileLength'''
+| width="90%" class="mtx-class-macrohead" | '''ReadFileLength'''
 |-
 | colspan="2" | Not currently implemented on the RPI&nbsp;
@@ Line 258: / Line 258: @@
 ===ReadFileSize===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFileSize'''
+| width="90%" class="mtx-class-macrohead" | '''ReadFileSize'''
 |-
 | colspan="2" | Reads the entire size of the current file in bytes.&nbsp;
@@ Line 272: / Line 272: @@
 ===ReadStringFromFile===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadStringFromFile'''
+| width="90%" class="mtx-class-macrohead" | '''ReadStringFromFile'''
 |-
 | colspan="2" | Reads a string from the currently open file. Auto increments the position in the file. An empty string signifies the end of the file has been reached.&nbsp;
@@ Line 296: / Line 296: @@
 ===SetFileIndex===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFileIndex'''
+| width="90%" class="mtx-class-macrohead" | '''SetFileIndex'''
 |-
 | colspan="2" | &nbsp;
@@ Line 315: / Line 315: @@
 ===WriteByteToBuffer===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteByteToBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''WriteByteToBuffer'''
 |-
 | colspan="2" | Not currently implemented on the RPI&nbsp;
@@ Line 339: / Line 339: @@
 ===WriteFileSector===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteFileSector'''
+| width="90%" class="mtx-class-macrohead" | '''WriteFileSector'''
 |-
 | colspan="2" | Not currently implemented on the RPI&nbsp;
@@ Line 354: / Line 354: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 370: / Line 370: @@
 | colspan="2" | Number of simultaneous files we want to access.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)