Component: File (RPI) (File)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd. |
| Version | 2.7 |
| Category | File |
Contents
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 |
| 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 |
| Not currently implemented on the RPI | |
| - BYTE
|
ForceNextSector |
| - BYTE
|
Return |
|
|
WriteByteToBuffer |
| Not currently implemented on the RPI | |
| - UINT
|
Address |
| - BYTE
|
Data |
 - VOID
|
Return |
|
|
AppendByteToFile |
| - BYTE
|
Data |
| - BYTE
|
Return |
|
|
CloseFile |
| - VOID
|
Return |
|
|
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 |
| Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer. | |
 - ULONG
|
Address |
| - BYTE
|
Return |
|
|
DeleteFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CreateFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
OpenFolder |
| - STRING
|
Folder_Name |
| - BYTE
|
Return |
|
|
ReadFileLength |
| Not currently implemented on the RPI | |
 - INT
|
Return |
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
Return |
|
|
SetFileIndex |
| - BYTE
|
File_Index |
| Range: 0 to 4 | |
| - VOID
|
Return |
|
|
AppendStringToFile |
| - STRING
|
Data_String |
| - BYTE
|
Return |
|
|
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 |
==Macro reference==
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
ForceNextSector |
| - BYTE
|
Return |
|
|
WriteByteToBuffer |
| Not currently implemented on the RPI | |
| - UINT
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
AppendByteToFile |
| - BYTE
|
Data |
| - BYTE
|
Return |
|
|
CloseFile |
| - VOID
|
Return |
|
|
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 |
| Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer. | |
| - ULONG
|
Address |
| - BYTE
|
Return |
|
|
DeleteFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CreateFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
OpenFolder |
| - STRING
|
Folder_Name |
| - BYTE
|
Return |
|
|
ReadFileLength |
| Not currently implemented on the RPI | |
| - INT
|
Return |
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
Return |
|
|
SetFileIndex |
| - BYTE
|
File_Index |
| Range: 0 to 4 | |
| - VOID
|
Return |
|
|
AppendStringToFile |
| - STRING
|
Data_String |
| - BYTE
|
Return |
|
|
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 |
==Macro reference==
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
ForceNextSector |
| - BYTE
|
Return |
|
|
WriteByteToBuffer |
| Not currently implemented on the RPI | |
| - UINT
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
AppendByteToFile |
| - BYTE
|
Data |
| - BYTE
|
Return |
|
|
CloseFile |
| - VOID
|
Return |
|
|
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 |
| Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer. | |
| - ULONG
|
Address |
| - BYTE
|
Return |
|
|
DeleteFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CreateFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
OpenFolder |
| - STRING
|
Folder_Name |
| - BYTE
|
Return |
|
|
ReadFileLength |
| Not currently implemented on the RPI | |
| - INT
|
Return |
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
Return |
|
|
SetFileIndex |
| - BYTE
|
File_Index |
| Range: 0 to 4 | |
| - VOID
|
Return |
|
|
AppendStringToFile |
| - STRING
|
Data_String |
| - BYTE
|
Return |
|
|
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 |
==Macro reference==
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
ForceNextSector |
| - BYTE
|
Return |
|
|
WriteByteToBuffer |
| Not currently implemented on the RPI | |
| - UINT
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
AppendByteToFile |
| - BYTE
|
Data |
| - BYTE
|
Return |
|
|
CloseFile |
| - VOID
|
Return |
|
|
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 |
| Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer. | |
| - ULONG
|
Address |
| - BYTE
|
Return |
|
|
DeleteFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CreateFile |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
OpenFolder |
| - STRING
|
Folder_Name |
| - BYTE
|
Return |
|
|
ReadFileLength |
| Not currently implemented on the RPI | |
| - INT
|
Return |
|
|
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 |
| Not currently implemented on the RPI | |
| - BYTE
|
Return |
|
|
SetFileIndex |
| - BYTE
|
File_Index |
| Range: 0 to 4 | |
| - VOID
|
Return |
|
|
AppendStringToFile |
| - STRING
|
Data_String |
| - BYTE
|
Return |
|
|
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 |
