ff_file.h File Reference

#include "ff_config.h"
#include "ff_types.h"
#include "ff_ioman.h"
#include "ff_dir.h"

Include dependency graph for ff_file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_FF_FILE

Macros
#define	FF_SEEK_SET   1
#define	FF_SEEK_CUR   2
#define	FF_SEEK_END   3

Typedefs
typedef struct _FF_FILE	FF_FILE
typedef struct _FF_FILE *	PFF_FILE

Functions
FF_FILE *	FF_Open (FF_IOMAN *pIoman, const FF_T_WCHAR *path, FF_T_UINT8 Mode, FF_ERROR *pError)
FF_T_BOOL	FF_isDirEmpty (FF_IOMAN *pIoman, const FF_T_WCHAR *Path)
FF_ERROR	FF_RmFile (FF_IOMAN *pIoman, const FF_T_WCHAR *path)
FF_ERROR	FF_RmDir (FF_IOMAN *pIoman, const FF_T_WCHAR *path)
FF_ERROR	FF_Move (FF_IOMAN *pIoman, const FF_T_WCHAR *szSourceFile, const FF_T_WCHAR *szDestinationFile)
FF_ERROR	FF_Close (FF_FILE *pFile)
FF_T_SINT32	FF_GetC (FF_FILE *pFile)
FF_T_SINT32	FF_GetLine (FF_FILE *pFile, FF_T_INT8 *szLine, FF_T_UINT32 ulLimit)
FF_T_SINT32	FF_Read (FF_FILE *pFile, FF_T_UINT32 ElementSize, FF_T_UINT32 Count, FF_T_UINT8 *buffer)
FF_T_SINT32	FF_Write (FF_FILE *pFile, FF_T_UINT32 ElementSize, FF_T_UINT32 Count, FF_T_UINT8 *buffer)
FF_T_BOOL	FF_isEOF (FF_FILE *pFile)
FF_ERROR	FF_Seek (FF_FILE *pFile, FF_T_SINT32 Offset, FF_T_INT8 Origin)
FF_T_SINT32	FF_PutC (FF_FILE *pFile, FF_T_UINT8 Value)
FF_T_UINT32	FF_Tell (FF_FILE *pFile)
FF_T_UINT8	FF_GetModeBits (FF_T_INT8 *Mode)

Detailed Description

Author

James Walmsley

Definition in file ff_file.h.

Macro Definition Documentation

FF_SEEK_CUR

#define FF_SEEK_CUR   2

Definition at line 52 of file ff_file.h.

FF_SEEK_END

#define FF_SEEK_END   3

Definition at line 53 of file ff_file.h.

FF_SEEK_SET

#define FF_SEEK_SET   1

Definition at line 51 of file ff_file.h.

Typedef Documentation

FF_FILE

typedef struct _FF_FILE FF_FILE

PFF_FILE

typedef struct _FF_FILE * PFF_FILE

Function Documentation

FF_Close()

FF_ERROR FF_Close

(

FF_FILE *

pFile

)

FF_GetC()

FF_T_SINT32 FF_GetC

(

FF_FILE *

pFile

)

FF_GetLine()

FF_T_SINT32 FF_GetLine	(	FF_FILE *	pFile,
		FF_T_INT8 *	szLine,
		FF_T_UINT32	ulLimit
	)

FF_GetModeBits()

FF_T_UINT8 FF_GetModeBits

(

FF_T_INT8 *

Mode

)

FF_isDirEmpty()

FF_T_BOOL FF_isDirEmpty	(	FF_IOMAN *	pIoman,
		const FF_T_WCHAR *	Path
	)

FF_isEOF()

FF_T_BOOL FF_isEOF

(

FF_FILE *

pFile

)

FF_Move()

FF_ERROR FF_Move	(	FF_IOMAN *	pIoman,
		const FF_T_WCHAR *	szSourceFile,
		const FF_T_WCHAR *	szDestinationFile
	)

FF_Open()

FF_FILE * FF_Open	(	FF_IOMAN *	pIoman,
		const FF_T_WCHAR *	path,
		FF_T_UINT8	Mode,
		FF_ERROR *	pError
	)

FF_PutC()

FF_T_SINT32 FF_PutC	(	FF_FILE *	pFile,
		FF_T_UINT8	Value
	)

FF_Read()

FF_T_SINT32 FF_Read	(	FF_FILE *	pFile,
		FF_T_UINT32	ElementSize,
		FF_T_UINT32	Count,
		FF_T_UINT8 *	buffer
	)

FF_RmDir()

FF_ERROR FF_RmDir	(	FF_IOMAN *	pIoman,
		const FF_T_WCHAR *	path
	)

FF_RmFile()

FF_ERROR FF_RmFile	(	FF_IOMAN *	pIoman,
		const FF_T_WCHAR *	path
	)

FF_Seek()

FF_ERROR FF_Seek	(	FF_FILE *	pFile,
		FF_T_SINT32	Offset,
		FF_T_INT8	Origin
	)

FF_Tell()

FF_T_UINT32 FF_Tell

(

FF_FILE *

pFile

)

FF_Write()

FF_T_SINT32 FF_Write	(	FF_FILE *	pFile,
		FF_T_UINT32	ElementSize,
		FF_T_UINT32	Count,
		FF_T_UINT8 *	buffer
	)