FSFile_IsErr()

CPU_BOOLEAN  FSFile_IsErr (FS_FILE  *p_file,
                           FS_ERR   *p_err);

File

Called from

Code enabled by

fs_file.cApplication;
fs_ferr()
N/A

Test error indicator on a file.

See fs_ferror() for more information.

Arguments

p_file

Pointer to a file.

p_err

Pointer to variable that will receive the return error code from this function:

FS_ERR_NONE

Error indicator obtained.

FS_ERR_NULL_PTR

Argument p_file passed a NULL pointer.

FS_ERR_INVALID_TYPE

Argument p_file's type is invalid or unknown.

FS_ERR_FILE_NOT_OPEN

File not open.

Returned Value

DEF_NO if error indicator is not set or if an error occurred

DEF_YES if error indicator is set.

Notes/Warnings

None.