ContentsIndex
PreviousUpNext
File System
Topics | Functions | Structs, Records, Enums | Types
Description

A file system that provides file or folder related operations.

Introduction

It provides functions for the applications to do file and folder related operations, such as open, close, find, copy, remove a file or folder; check the available space in the file system; read or write a file, or move the file pointer, etc.

Limitation

N/A

Group
Functions
Function 
Description 
Closes the application data file file. 
Deletes the content in the application data space. 
Checks the size of the current available free space for the application data. Each application (a VXP file) is assigned with a storage space for the application data. The application is responsible for not storing data that exceeds the size of the assigned space. 
Opens the application data file in system drive disk. 
Reads the application data from the data file, pointed to by the file handle. 
Moves the system data file pointer to a specific position. If the specified position exceeds the size of the file, an error will be returned. If the function succeeds, the return value is the new file pointer value,
Moving the file pointer before the beginning of the file is an error. However, moving the file pointer beyond the current file size is supported. In this case, the file is extended. The data between the previous file size and the new file size is undefined. This method is used to extend a file, which is a much faster way than actually... more 
Writes data at the current position of the data file, pointed to by the handle. 
Closes a file that is opened by vm_fs_open(). 
Copies a file from source to destination. The filenames of source and destination are full path encoded in UCS-2. 
Aborts a file copy. This function should be only invoked inside the callback function of the file copy operation. 
Creates a new directory with specified path name, encoded in UCS-2. 
Deletes the file as specified by the full path of the filename. 
Closes the file finding process and releases the resource. 
Close the file finding process and releases the resource. 
Finds the first file or folder under the specified path, and return a handle. This function supports the wild character (*) in the search pattern. The size and the full path of the first file or folder (no size if it is a folder) is returned through the out parameter of the vm_fs_info_t object.
A handle of this find function is returned to the caller, which can be used for getting the next file or folder by vm_fs_find_next().
The caller of this function should call vm_fs_find_close() to release the resource after it is done with the handle. 
Similar to the vm_fs_find_first(), except it obtains more information, as specified in vm_fs_info_ex_t, for the file or folder from the system.
It finds the first file or folder under the specified path, and return a handle. This function supports the wild character (*) in the search pattern. The file or folder information is returned through the out parameter of the vm_fs_info_ex_t object.
A handle of this find function is returned to the caller, which can be used for getting the next file or folder by calling vm_fs_find_next_ex().
The caller of this function should call vm_fs_find_close_ex() to... more 
Gets the next file or folder from the VM_FS_HANDLE object,which is returned from the vm_fs_find_first(). If exists, the size and the full path of the file or folder (no size if it is a folder) is returned through the out parameter of the vm_fs_info_t object. If there is no file or folder exists, the VM_FS_NO_MORE_FILES error code is returned 
Gets the information of the next file or folder from the VM_FS_HANDLE object, which is returned from the vm_fs_find_first_ex(). If the next file or folder exists, the information of the file or folder is returned through the out parameter of the vm_fs_info_ex_t object. If no file or folder exists, the VM_FS_NO_MORE_FILES error code is returned. 
Commits the I/O cache data to a file. 
Retrieves the attributes of a file or directory, as specified by the full path name, encoded in UCS-2. The value of the attributes is the result of bitwise OR operation of individual attribute. 
Checks the available free space on the specified drive. It returns the size of the available free space in bytes. 
Gets disk information of a logical drive. 
Gets drive letter of the removable disk, which normally is the memory card. 
Gets the current position of the file pointer of the file, pointed to by the specified file handle. 
Gets the drive letter of the removable disk, which normally is the memory card. 
Obtains the size of the file in bytes. The file is specified by the file handle. 
Checks if the current file pointer has reached to the end of the file. 
Opens a file. It opens the file as a binary file, if the is_binary is VM_TRUE. If the is_binary is VM_FALSE, it opens the file as an ASCII file. 
Reads the file through the file handle. 
Removes a directory as specified by full path name, encoded in UCS-2. 
Renames the file. Both old_name and new_name are full path of a filename, encoded in UCS-2. 
Moves the file pointer to a specific position. If the specified position exceeds the size of the file, an error will be returned. If the function succeeds, the return value is the new file pointer value,
Moving the file pointer before the beginning of the file is an error. However, moving the file pointer beyond the current file size is supported. In this case, the file is extended. The data between the previous file size and the new file size is undefined. This method is used to extend a file, which is a much faster way than actually writing data... more 
Sets the attributes for a file or directory as specified full path filename, encoded in UCS-2. The attributes can not include VM_FS_ATTRIBUTE_VOLUME, VM_FS_ATTRIBUTE_DIRECTORY, or VM_FS_LONGNAME_ATTRIBUTE. The value of attributes is the result of bitwise OR operation of individual attribute. 
Writes data in the buffer to a file pointed to by the file handle. 
Structs, Records, Enums
Struct, Record, Enum 
Description 
File attribution. 
File base. 
vm_fs_get_disk_info Parameter 
Disk information 
File information 
File information 
File mode. 
File system return values. 
Types
Type 
Description 
Defines a callback function type for file copy. 
Links
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.