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

Revision as of 11:49, 3 February 2023

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

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

MoveToNextFileSector

	MoveToNextFileSector
Not currently implemented on the RPI
- BYTE	ForceNextSector

- BYTE	Return

WriteByteToBuffer

	WriteByteToBuffer
Not currently implemented on the RPI
- UINT	Address

- BYTE	Data

- VOID	Return

AppendByteToFile

	AppendByteToFile

- BYTE	Data

- BYTE	Return

CloseFile

	CloseFile

- VOID	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

DeleteFile

	DeleteFile

- STRING	Filename

- BYTE	Return

CreateFile

	CreateFile

- STRING	Filename

- BYTE	Return

OpenFolder

	OpenFolder

- STRING	Folder_Name

- BYTE	Return

ReadFileLength

	ReadFileLength
Not currently implemented on the RPI
- INT	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

WriteFileSector

	WriteFileSector
Not currently implemented on the RPI
- BYTE	Return

SetFileIndex

	SetFileIndex

- BYTE	File_Index
Range: 0 to 4
- VOID	Return

AppendStringToFile

	AppendStringToFile

- STRING	Data_String

- BYTE	Return

ReadFileSize

	ReadFileSize
Reads the entire size of the current file in bytes.
- ULONG	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 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 53: / Line 55: @@
 ==Macro reference==
+===ReadStringFromFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 76: / Line 79: @@
+===MoveToNextFileSector===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 94: / Line 98: @@
+===WriteByteToBuffer===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 117: / Line 122: @@
+===AppendByteToFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 135: / Line 141: @@
+===CloseFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 148: / Line 155: @@
+===ReadByteFromFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 161: / Line 169: @@
+===ReadByteFromIndex===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 179: / Line 188: @@
+===DeleteFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 197: / Line 207: @@
+===CreateFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 215: / Line 226: @@
+===OpenFolder===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 233: / Line 245: @@
+===ReadFileLength===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 246: / Line 259: @@
+===OpenFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 264: / Line 278: @@
+===WriteFileSector===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 277: / Line 292: @@
+===SetFileIndex===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 295: / Line 311: @@
+===AppendStringToFile===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 313: / Line 330: @@
+===ReadFileSize===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-