csad::File Class Reference

File - A file object. More...

Public Types
enum	IOType {   READ, WRITE, READWRITE, CREATE,   CREATERW }
enum	PosFrom { BEGIN, CURRENT, END }

Public Member Functions
PLATFORM_API	File (IOType io)
	Конструктор
PLATFORM_API	File (char *name, IOType io=READ)
	Конструктор
PLATFORM_API bool	close ()
	closes the file More...
_FORCEINLINE void *	getHeader ()
PLATFORM_API bool	open ()
	opens or creates a new file More...
PLATFORM_API int	read (void *data, int count)
	read block of data from a file More...
PLATFORM_API char *	readAll ()
	создает буфер разбером в файл и читает из него все содержимое
PLATFORM_API void	setFileName (char *)
	sets the name of the file
PLATFORM_API void	setPos (_int64 pos, int from)
	setting the position in the file More...
PLATFORM_API int	size ()
	The total file size. More...
PLATFORM_API int	write (void *data, int count)
	writes a block of data to a file More...

Detailed Description

File - A file object.

See Also

BaseFile, csad: platform

Member Enumeration Documentation

enum csad::File::IOType

Enumerator
READ	открыть файл для чтения
WRITE	открыть файл для записи
READWRITE	открыть файл для записи и чтения
CREATE	cоздать файл для записи
CREATERW	cоздать файл для записи и чтения

enum csad::File::PosFrom

Enumerator
BEGIN	since the beginning of the file
CURRENT	from the current position
END	with the end of the file

Member Function Documentation

bool csad::File::close

(

)

closes the file

Закрывает файл

_FORCEINLINE void* csad::File::getHeader ( )

inline

Returns indicator file depends on your operating system

Returns

the file ID.

bool csad::File::open

(

)

opens or creates a new file

Открывает файл

int csad::File::read	(	void *	data,
		int	count
	)

read block of data from a file

Read byte sequence using cache buffer.

Parameters

data	- buffer to load the data.
count	- the size of the buffer in bytes.

Returns

the number of bytes read.

void csad::File::setPos	(	_int64	pos,
		int	from
	)

setting the position in the file

To set the file position.

Parameters

pos	- the offset in bytes.
from	- defines the form of displacement.

int csad::File::size

(

)

The total file size.

Общий размер файла

Returns

общий размер файла.

the total file size

int csad::File::write	(	void *	data,
		int	count
	)

writes a block of data to a file

The entry sequence of bytes using cache buffer.

Parameters

data	- buffer data being written.
count	- the size of the buffer in bytes.

Returns

the number of bytes written.