osal_file_types.h File Reference

Public types for the osal_file module. More...

Go to the source code of this file.

Typedefs
typedef struct OSAL_FILE	OSAL_FILE
	Opaque OSAL file handle.
typedef enum osal_file_status	osal_file_status_t
	Portable status codes for low-level OSAL file operations.

Enumerations
enum	osal_file_status {   OSAL_FILE_STATUS_OK = 0 , OSAL_FILE_STATUS_INVALID , OSAL_FILE_STATUS_NOENT , OSAL_FILE_STATUS_PERM ,   OSAL_FILE_STATUS_EXISTS , OSAL_FILE_STATUS_NOSPC , OSAL_FILE_STATUS_NAMETOOLONG , OSAL_FILE_STATUS_NOTDIR ,   OSAL_FILE_STATUS_ISDIR , OSAL_FILE_STATUS_BADF , OSAL_FILE_STATUS_FBIG , OSAL_FILE_STATUS_INTR ,   OSAL_FILE_STATUS_MFILE , OSAL_FILE_STATUS_NFILE , OSAL_FILE_STATUS_LOOP , OSAL_FILE_STATUS_ROFS ,   OSAL_FILE_STATUS_SPIPE , OSAL_FILE_STATUS_XDEV , OSAL_FILE_STATUS_NODEV , OSAL_FILE_STATUS_NXIO ,   OSAL_FILE_STATUS_STALE , OSAL_FILE_STATUS_OOM , OSAL_FILE_STATUS_IO }
	Portable status codes for low-level OSAL file operations. More...

Detailed Description

This header exposes:

• the opaque OSAL_FILE handle type used by the low-level OSAL file API,
• the portable osal_file_status_t status codes returned by osal_file operations.

Definition in file osal_file_types.h.

Typedef Documentation

OSAL_FILE

typedef struct OSAL_FILE OSAL_FILE

An OSAL_FILE designates a file resource acquired through osal_file_ops_t::open and released through osal_file_ops_t::close.

On successful open, ownership of the acquired handle belongs to the caller until the handle is released through the matching close operation.

Definition at line 31 of file osal_file_types.h.

osal_file_status_t

typedef enum osal_file_status osal_file_status_t

Enumeration Type Documentation

osal_file_status

enum osal_file_status

Enumerator
OSAL_FILE_STATUS_OK
OSAL_FILE_STATUS_INVALID
OSAL_FILE_STATUS_NOENT
OSAL_FILE_STATUS_PERM
OSAL_FILE_STATUS_EXISTS
OSAL_FILE_STATUS_NOSPC
OSAL_FILE_STATUS_NAMETOOLONG
OSAL_FILE_STATUS_NOTDIR
OSAL_FILE_STATUS_ISDIR
OSAL_FILE_STATUS_BADF
OSAL_FILE_STATUS_FBIG
OSAL_FILE_STATUS_INTR
OSAL_FILE_STATUS_MFILE
OSAL_FILE_STATUS_NFILE
OSAL_FILE_STATUS_LOOP
OSAL_FILE_STATUS_ROFS
OSAL_FILE_STATUS_SPIPE
OSAL_FILE_STATUS_XDEV
OSAL_FILE_STATUS_NODEV
OSAL_FILE_STATUS_NXIO
OSAL_FILE_STATUS_STALE
OSAL_FILE_STATUS_OOM
OSAL_FILE_STATUS_IO

Definition at line 36 of file osal_file_types.h.