Types
File types. More...
Data Structures |
|
struct | gos_file_t |
struct | gos_file_descriptor_t |
struct | gos_file_list_parameters_t |
struct | gos_file_system_stats_t |
Statistics about the file system.
More...
|
|
Typedefs |
|
typedef uint32_t | gos_file_handle_t |
typedef gos_result_t (* | gos_file_list_callback_t ) (const gos_file_t *file, void *user) |
Detailed Description
File types.
Typedef Documentation
◆ gos_file_handle_t
typedef uint32_t gos_file_handle_t |
File handle
◆ gos_file_list_callback_t
typedef gos_result_t (* gos_file_list_callback_t) (const gos_file_t *file, void *user) |
Callback invoked when listing files
This is a callback that is invoked for each listed file. This may be used to provide further filtering.
- Parameters
-
file
Details about current file, see gos_file_t user
User provided argument provided to listing API
- Returns
- IF GOS_SUCCESS then add file to listing, ELIF GOS_ABORTED then drop file from listing, ELSE quit file listing and return error
Enumeration Type Documentation
◆ gos_file_flag_t
enum gos_file_flag_t |
File flags
◆ gos_file_location_mask_t
File location bitmask
See gos_file_location_t for more information
◆ gos_file_location_t
enum gos_file_location_t |
File location
This specifies where the file resides.
◆ gos_file_mode_t
enum gos_file_mode_t |
◆ gos_file_owner_t
enum gos_file_owner_t |
File owner
The file's owner indicates which encryption key is used to encrypt/decrypt a file.
Enumerator | |
---|---|
GOS_FILE_OWNER_NONE |
No owner. |
GOS_FILE_OWNER_PRODUCT |
File owned by DMS product (system used only) |
GOS_FILE_OWNER_DEVICE |
File owned by the device (if the GOS_FILE_FLAG_ENCRYPTED flag is set then the device's encryption key is used for encryption/decryption) |
GOS_FILE_OWNER_USER |
File owned by user (if the
GOS_FILE_FLAG_ENCRYPTED
flag is set then the
|
GOS_FILE_OWNER_INVALID |
Invalid owner. |
◆ gos_file_permission_t
File permissions
The file permissions indicates which command interface has access to the file.
- Note
- The File APIs always have access to the files regardless of the permissions set.
◆ gos_file_type_t
enum gos_file_type_t |
File types
Types before GOS_FILE_TYPE_USER_TYPES_START are reserved for system use. Types before GOS_FILE_TYPE_CUSTOM_START are available to the user, but new values may not be defined by the user. Types after GOS_FILE_TYPE_CUSTOM_START are available to the user and the user may define new values.