file.h File Reference

Go to the source code of this file.

Data Structures
struct	s_FILE_STRUCT
	File structure. More...

Macros
#define	s_FILE_MODE_READ   "r"
#define	s_FILE_MODE_WRITE   "w"
#define	s_FILE_MODE_APPEND   "a"
#define	s_FILE_MODE_RW_START   "r+"
#define	s_FILE_MODE_RW_OVER   "w+"
#define	s_FILE_MODE_RW_APPEND   "a+"

Typedefs
typedef struct s_FILE_STRUCT	file_t
	File structure. More...

Functions
file_t *	file_open (const char *name, const char *mode)
file_t *	file_open_time (const char *name, const char *ext, const char *mode)
int	file_close (file_t *fs)
int	file_write (file_t *fs, char *data, int len)
int	file_write_direct (file_t *fs, char *data, int len)
int	file_flush (file_t *fs)
int	file_readln (file_t *fs, char *buffer, size_t buflen)

Detailed Description

Author

Eriks Zaharans

Date

1 Jul 2013

DESCRIPTION

File handling library header file.

Definition in file file.h.

Macro Definition Documentation

#define s_FILE_MODE_APPEND   "a"

Definition at line 33 of file file.h.

#define s_FILE_MODE_READ   "r"

Definition at line 31 of file file.h.

#define s_FILE_MODE_RW_APPEND   "a+"

Definition at line 36 of file file.h.

#define s_FILE_MODE_RW_OVER   "w+"

Definition at line 35 of file file.h.

#define s_FILE_MODE_RW_START   "r+"

Definition at line 34 of file file.h.

#define s_FILE_MODE_WRITE   "w"

Definition at line 32 of file file.h.

Typedef Documentation

typedef struct s_FILE_STRUCT file_t

File structure.

Function Documentation

int file_close

(

file_t *

fs

)

Close file

Parameters

fs	Pointer to file structure

Returns

s_OK if successfully closed, otherwise s_ERROR

Definition at line 82 of file file.c.

int file_flush

(

file_t *

fs

)

Flush file

Parameters

fs	Pointer to file structure

Returns

s_OK if successfully flushed, otherwise s_ERROR

Definition at line 132 of file file.c.

file_t* file_open	(	const char *	name,
		const char *	mode
	)

Open file

Parameters

name	File file name
mode	File file open mode (r, w, a, r+, w+, a+)

Returns

Pointer to file structure

Definition at line 31 of file file.c.

file_t* file_open_time	(	const char *	name,
		const char *	ext,
		const char *	mode
	)

Open file - name includes datetime (use only to create files)

Parameters

name	File name
ext	File extension ('txt', 'dat', etc.)
mode	File open mode (r, w, a, r+, w+, a+)

Returns

Pointer to file structure

Definition at line 52 of file file.c.

int file_readln	(	file_t *	fs,
		char *	buffer,
		size_t	buflen
	)

Read line form file

Parameters

fs	Pointer to file structure
buffer	Buffer where to save read line
buflen	Size of buffer

Returns

Number of char read

Definition at line 145 of file file.c.

int file_write	(	file_t *	fs,
		char *	data,
		int	len
	)

Write to file

Parameters

fs	Pointer to file structure
data	Data to write to file
len	Length of data

Returns

The total number of elements successfully written

Definition at line 101 of file file.c.

int file_write_direct	(	file_t *	fs,
		char *	data,
		int	len
	)

Write and flush to file

Parameters

fs	Pointer to file structure
data	Data to write to file
len	Length of data

Returns

The total number of elements successfully written

Definition at line 114 of file file.c.