fesFile.h File Reference

Definitions for the file operation routines. More...

#include <fesParm.h>

Classes
struct	fesFileStat_s
	File status. More...
struct	fesFileStatFs_s
	File system status. More...
struct	fesDiskInfo_s
	Disk information. More...
struct	fesDirInfo_s
	Directory information. More...
struct	fesFileInfo_s
	File information. More...
Typedefs
typedef struct fesFileStat_s	fesFileStat_t
	File status.
typedef struct fesFileStatFs_s	fesFileStatFs_t
	File system status.
typedef struct fesDiskInfo_s	fesDiskInfo_t
	Disk information.
typedef struct fesDirInfo_s	fesDirInfo_t
	Directory information.
typedef struct fesFileInfo_s	fesFileInfo_t
	File information.
Enumerations
enum	{   FFO_RDONLY = 0,   FFO_WRONLY = 1,   FFO_RDWR = 2,   FFO_CREAT = 0x10,   FFO_APPEND = 0x20,   FFO_TRUNC = 0x40 }
	Open flags. More...
enum	{   FFS_START = 0,   FFS_CURR = 1,   FFS_END = 2 }
	Seek bases. More...
enum	{   FST_NONE = 0,   FST_NAME = 1,   FST_DATE = 2,   FST_SIZE = 3 }
	Sort types. More...
enum	{   FDT_NODIR = 1,   FDT_NOINFO = 2 }
	Display types. More...
enum	{   FPO_IGNCASE = 0x01,   FPO_SRCHTRE = 0x02,   FPO_DELTREE = 0x04 }
	Processing options. More...
enum	{   FDO_BYTES = 0x01,   FDO_SHORTS = 0x02,   FDO_WIDE = 0x04,   FDO_TEXT = 0x08,   FDO_LITEND = 0x10 }
	File dump options. More...
enum	{   ITP_END = 0,   ITP_DIR = 1,   ITP_FILE = 2 }
	Information types. More...
enum	{   IST_OKAY = 0,   IST_TRUNC = 1,   IST_NOSTAT = 2,   IST_NODIR = 3 }
	Information status values. More...
Functions
int	fesFileDiskFormat (int unit, int noConf)
int	fesFileInit (void)
int	fesFileClose (void *hndl)
int	fesFileCopy (const char *sName, const char *dName, int copyTree)
int	fesFileDel (const char *name, int option, int fOptns, int *nDelete)
int	fesFileDirCre (const char *name, int creInt, int *errorP)
int	fesFileDirNameComp (const char *dName1, const char *dName2)
int	fesFileDiskInfoGet (const char *name, char *nName, int *nDisk, fesDiskInfo_t **dInfo)
const char *	fesFileDiskName (int unit, int system)
int	fesFileDiskShow (const char *name)
int	fesFileDump (const char *name, long long first, int count, int pSize, int optns)
int	fesFileFlush (void *hndl)
int	fesFileInfoAdd (const char *data, char **info, int *iLeng, int *cLeng)
int	fesFileInfoGet (const char *name, int optns, char *nName, int *size, char **fInfo)
int	fesFileInfoNext (const char *info, fesDirInfo_t **dInfo, fesFileInfo_t **fInfo, int *newDir)
fesFileInfo_t **	fesFileInfoSort (const fesDirInfo_t *dInfo, const fesFileInfo_t *fInfo, int sortType)
int	fesFileNameComp (const char *fName1, const char *fName2)
int	fesFileOpen (void **hndl, const char *name, int optns)
int	fesFileRead (void *hndl, char *buff, int leng, int *nRead)
int	fesFileRename (const char *name, const char *nName)
int	fesFileSeek (void *hndl, int base, long long offset, long long *posn)
int	fesFileShow (const char *name, int optns, int dispType, int sortType)
int	fesFileStat (void *hndl, fesFileStat_t *fStat)
int	fesFileStatShow (const char *name)
int	fesFileTimeRead (const char *name, int bufSize, int check)
int	fesFileTimeWrite (const char *name, long long flSize, int bufSize)
int	fesFileUtime (const char *name, unsigned int *aTime, unsigned int *mTime)
int	fesFileWrite (void *hndl, const char *buff, int leng, int *nWrte)

---

Detailed Description

Definitions for the file operation routines.

Author:

Owen H Saxton

$Id: fesFile.h,v 1.12 2011/03/29 23:04:20 saxton Exp $

---

Enumeration Type Documentation

anonymous enum

Open flags.

Enumerator:

FFO_RDONLY	Read only (= O_RDONLY).
FFO_WRONLY	Write only (= O_WRONLY).
FFO_RDWR	Read/write (= O_RDWR).
FFO_CREAT	Create if non-existent.
FFO_APPEND	Append every write.
FFO_TRUNC	Truncate size to zero.

anonymous enum

Seek bases.

Enumerator:

FFS_START	Start of file (= SEEK_SET).
FFS_CURR	Current file posn (= SEEK_CUR).
FFS_END	End of file (= SEEK_END).

anonymous enum

Sort types.

Enumerator:

FST_NONE	No sort.
FST_NAME	Sort by name.
FST_DATE	Sort by date.
FST_SIZE	Sort by size.

anonymous enum

Display types.

Enumerator:

FDT_NODIR	No directory line.
FDT_NOINFO	No size & date info.

anonymous enum

Processing options.

Enumerator:

FPO_IGNCASE	Ignore case in names.
FPO_SRCHTRE	Search directory tree.
FPO_DELTREE	Delete directory tree.

anonymous enum

File dump options.

Enumerator:

FDO_BYTES	Output data as single bytes.
FDO_SHORTS	Output data as shorts (2 bytes).
FDO_WIDE	Do a wide dump (32 bytes / line).
FDO_TEXT	Display file as text as well as hexadecimal.
FDO_LITEND	Display file from right to left.

anonymous enum

Information types.

Enumerator:

ITP_END	End of data.
ITP_DIR	Directory.
ITP_FILE	File.

anonymous enum

Information status values.

Enumerator:

IST_OKAY	Everything okay.
IST_TRUNC	Name truncated.
IST_NOSTAT	Can't get file status.
IST_NODIR	Can't read directory.