Function esp_idf_svc::hal::sys::esp_vfs_register
source · pub unsafe extern "C" fn esp_vfs_register(
base_path: *const i8,
vfs: *const esp_vfs_t,
ctx: *mut c_void,
) -> i32
Expand description
Register a virtual filesystem for given path prefix.
@param base_path file path prefix associated with the filesystem. Must be a zero-terminated C string, may be empty. If not empty, must be up to ESP_VFS_PATH_MAX characters long, and at least 2 characters long. Name must start with a “/” and must not end with “/”. For example, “/data” or “/dev/spi” are valid. These VFSes would then be called to handle file paths such as “/data/myfile.txt” or “/dev/spi/0”. In the special case of an empty base_path, a “fallback” VFS is registered. Such VFS will handle paths which are not matched by any other registered VFS. @param vfs Pointer to esp_vfs_t, a structure which maps syscalls to the filesystem driver functions. VFS component doesn’t assume ownership of this pointer. @param ctx If vfs->flags has ESP_VFS_FLAG_CONTEXT_PTR set, a pointer which should be passed to VFS functions. Otherwise, NULL.
@return ESP_OK if successful, ESP_ERR_NO_MEM if too many VFSes are registered.