Jim Carver
Simulated product dispenser
Fork of
mbed-cloud-workshop-connect-HTS221
by 
Jim Carver
Embed:
(wiki syntax)
pal_plat_fileSystem.h File Reference
PAL file system - platform. This file contains the file system APIs that need to be implemented in the platform layer. More...
Go to the source code of this file.
Functions | |
| palStatus_t | pal_plat_fsMkdir (const char *pathName) |
This function attempts to create a directory named pathName. | |
| palStatus_t | pal_plat_fsRmdir (const char *pathName) |
| This function deletes a directory. | |
| palStatus_t | pal_plat_fsFopen (const char *pathName, pal_fsFileMode_t mode, palFileDescriptor_t *fd) |
| This function opens the file whose name is specified in the parameter `pathName` and associates it with a stream that can be identified in future operations by the `fd` pointer returned. | |
| palStatus_t | pal_plat_fsFclose (palFileDescriptor_t *fd) |
| This function closes an open file object. | |
| palStatus_t | pal_plat_fsFread (palFileDescriptor_t *fd, void *buffer, size_t numOfBytes, size_t *numberOfBytesRead) |
| This function reads an array of bytes from the stream and stores them in the block of memory specified by the buffer. The position indicator of the stream is advanced by the total amount of bytes read. | |
| palStatus_t | pal_plat_fsFwrite (palFileDescriptor_t *fd, const void *buffer, size_t numOfBytes, size_t *numberOfBytesWritten) |
This function starts to write data from the buffer to the file at the position pointed by the read/write pointer. | |
| palStatus_t | pal_plat_fsFseek (palFileDescriptor_t *fd, int32_t offset, pal_fsOffset_t whence) |
| This function moves the file read/write pointer without any read/write operation to the file. | |
| palStatus_t | pal_plat_fsFtell (palFileDescriptor_t *fd, int32_t *pos) |
| This function gets the current read/write pointer of a file. | |
| palStatus_t | pal_plat_fsUnlink (const char *pathName) |
| This function deletes a single file from the file system. | |
| palStatus_t | pal_plat_fsRmFiles (const char *pathName) |
| This function deletes all files in a folder from the file system (FLAT remove only). | |
| palStatus_t | pal_plat_fsCpFolder (const char *pathNameSrc, char *pathNameDest) |
| This function copies all files from a source folder to a destination folder (FLAT copy only). | |
| const char * | pal_plat_fsGetDefaultRootFolder (pal_fsStorageID_t dataID) |
| This function gets the default value for root directory (primary) | |
| size_t | pal_plat_fsSizeCheck (const char *stringToChk) |
| This function finds the length of the string received. | |
| palStatus_t | pal_plat_fsMountSystem (void) |
| This function sets up the mount point. | |
| palStatus_t | pal_plat_fsFormat (pal_fsStorageID_t dataID) |
| This function formats the SD partition indicated by `partitionID` (mapping the ID to an actual partition is done in the porting layer). | |
Detailed Description
PAL file system - platform. This file contains the file system APIs that need to be implemented in the platform layer.
Definition in file pal_plat_fileSystem.h.
Function Documentation
| palStatus_t pal_plat_fsFormat | ( | pal_fsStorageID_t | dataID ) |
This function formats the SD partition indicated by `partitionID` (mapping the ID to an actual partition is done in the porting layer).
- Parameters:
-
[in] partitionID The ID of the partition to be formatted.
- Returns:
- PAL_SUCCESS upon a successful operation.
PAL_FILE_SYSTEM_ERROR - see the error code descriptionpalError_t.
Definition at line 710 of file FreeRTOS/Storage/FileSystem/pal_plat_fileSystem.c.
Generated on Tue Jul 12 2022 19:12:18 by
1.7.2