Dokumentacja klasy common::FileStream
[Moduł Files]

Strumień plikowy. Więcej...

#include <Files.hpp>

Diagram dziedziczenia dla common::FileStream

Lista wszystkich składowych.

Metody publiczne
	FileStream (const tstring &FileName, FILE_MODE FileMode, bool Lock=true)
virtual	~FileStream ()
virtual void	Write (const void *Data, size_t Size)
	Zapisuje dane.
virtual size_t	Read (void *Data, size_t Size)
	Odczytuje dane.
virtual void	Flush ()
virtual size_t	GetSize ()
	Zwraca rozmiar.
virtual int	GetPos ()
	Zwraca pozycję względem początku.
virtual void	SetPos (int pos)
	Ustawia pozycję względem początku.
virtual void	SetPosFromCurrent (int pos)
	Ustawia pozycję względem bieżącej.
virtual void	SetPosFromEnd (int pos)
	Ustawia pozycję względem końcowej.
virtual void	SetSize (size_t Size)
	Ustawia rozmiar na podany.
virtual void	Truncate ()
	Obcina strumień od bieżącej pozycji do końca, czyli ustawia taki rozmiar jak bieżąca pozycja.
virtual bool	End ()

---

Opis szczegółowy

Strumień plikowy.

---

Dokumentacja konstruktora i destruktora

common::FileStream::FileStream	(	const tstring &	FileName,
		FILE_MODE	FileMode,
		bool	Lock = true
	)

virtual common::FileStream::~FileStream

(

)

[virtual]

---

Dokumentacja funkcji składowych

virtual void common::FileStream::Write	(	const void *	Data,
		size_t	Size
	)			[virtual]

Zapisuje dane.

(W oryginale: zgłasza błąd)

Reimplementowana z common::Stream.

virtual size_t common::FileStream::Read	(	void *	Data,
		size_t	MaxLength
	)			[virtual]

Odczytuje dane.

Jeśli osiągnięto koniec, funkcja nie zwraca błędu, a liczba odczytanych bajtów to 0. (W oryginale: zgłasza błąd)

Parametry:

Size

Liczba bajtów do odczytania

Zwraca:

Zwraca liczbę bajtów, jakie udało się odczytać

Reimplementowana z common::Stream.

virtual void common::FileStream::Flush

(

)

[virtual]

Reimplementowana z common::Stream.

virtual size_t common::FileStream::GetSize

(

)

[virtual]

Zwraca rozmiar.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual int common::FileStream::GetPos

(

)

[virtual]

Zwraca pozycję względem początku.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual void common::FileStream::SetPos

(

int

pos

)

[virtual]

Ustawia pozycję względem początku.

W oryginale: zgłasza błąd.

Parametry:

pos

Musi być dodatnie.

Reimplementowana z common::SeekableStream.

virtual void common::FileStream::SetPosFromCurrent

(

int

pos

)

[virtual]

Ustawia pozycję względem bieżącej.

Można ją nadpisać, ale ma wersję oryginalną

Parametry:

pos

może być dodatnie albo ujemne.

Reimplementowana z common::SeekableStream.

virtual void common::FileStream::SetPosFromEnd

(

int

pos

)

[virtual]

Ustawia pozycję względem końcowej.

Można ją nadpisać, ale ma wersję oryginalną. Np. abu ustawić na ostatni znak, przesuń do -1.

Reimplementowana z common::SeekableStream.

virtual void common::FileStream::SetSize

(

size_t

Size

)

[virtual]

Ustawia rozmiar na podany.

Po tym wywołaniu pozycja kursora jest niezdefiniowana. W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual void common::FileStream::Truncate

(

)

[virtual]

Obcina strumień od bieżącej pozycji do końca, czyli ustawia taki rozmiar jak bieżąca pozycja.

Można ją nadpisać, ale ma wersję oryginalną.

Reimplementowana z common::SeekableStream.

virtual bool common::FileStream::End

(

)

[virtual]

W Stream domyślnie rzuca błąd, tu w SeekableStream dostaje już wersję oryginalną. Można ją dalej nadpisać.

Reimplementowana z common::SeekableStream.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Files.hpp