Types
File types. More...
Data Structures | |
| struct | zos_file_t |
| Basic information about the file. More... | |
| struct | zos_file_parameters_t |
| File listing parameters. More... | |
| struct | zos_file_descriptor_t |
| Information about a file opened for reading or writing. More... | |
| struct | zos_file_system_stats_t |
| Statistics about the file system. More... | |
| struct | zos_log_stats_t |
| Information about a log file. More... | |
Typedefs | |
| typedef zos_bool_t(* | zos_file_list_callback_t) (void *user, zos_file_t *info) |
| Callback to determine if a file should be returned with zn_file_list_with_callback() More... | |
| typedef uint16_t | zos_log_header_t |
| Header prepended to each log record. More... | |
Detailed Description
File types.
Typedef Documentation
| typedef zos_bool_t(* zos_file_list_callback_t) (void *user, zos_file_t *info) |
Callback to determine if a file should be returned with zn_file_list_with_callback()
This callback is called for each found file in zn_file_list_with_callback(). If the return value of the callback is ZOS_TRUE then the file is included in the file listing. If the return value is ZOS_FALSE the file is omitted from the file listing.
- Parameters
-
userOptional user argument supplied to zn_file_list_with_callback() infoThe found file's information, zos_file_t
- Returns
- ZOS_TRUE if the file should be included in the listing, ZOS_FALSE else
| typedef uint16_t zos_log_header_t |
Header prepended to each log record.
- Note
- If the most-significant bit is cleared (i.e. 0) then the record is valid else the record is invalid (i.e. the log record data may not have been successfully written)
Enumeration Type Documentation
| enum zos_file_flag_t |
File flags.
| Enumerator | |
|---|---|
| FILE_FLAG_VALID |
Valid within the file system (system use only) |
| FILE_FLAG_EXECUTABLE |
Executable (system use only) |
| FILE_FLAG_ENCRYPTED |
Encrypted (system use only) |
| FILE_FLAG_INTERNAL |
Resides on internal MCU flash (system use only) |
| FILE_FLAG_BOOTABLE |
Bootable image (system use only) |
| FILE_FLAG_USER |
Created by a serial command (system use only) |
| FILE_FLAG_ESSENTIAL |
Essential, refer to the Wiki for more info. |
| FILE_FLAG_BACKUP |
Backed up on extended flash (system use only) |
| FILE_FLAG_UNPROTECTED |
NOT protected by the HTTP server auth credentials, refer to the Wiki for more info. |
| FILE_FLAG_LOG |
Log file, use the zn_file_read_log() / zos_file_append_log() APIs to read/write log records. |
| FILE_FLAG_USER_ENCRYPTED |
File is encrypted with a user specified AES-128 key, See ZentriOS variable API documentation: system.security_key |
| FILE_FLAG_INVALID |
Invalid. |
| enum zos_file_memory_t |
File memory type.
| enum zos_file_type_t |
The type of file.
Custom file types should be within the range: FILE_TYPE_USER_RANGE_START to FILE_TYPE_USER_RANGE_END