Dokumentacja klasy common::GzipFileStream
[Moduł ZlibUtils]

Obsługa pliku w formacie gzip (zalecane rozszerzenie ".gz"). Więcej...

#include <ZlibUtils.hpp>

Diagram dziedziczenia dla common::GzipFileStream

common::Stream

Lista wszystkich składowych.

Metody publiczne

 GzipFileStream (const string &FileName, GZIP_FILE_MODE Mode, int Level=ZLIB_DEFAULT_LEVEL)
virtual ~GzipFileStream ()
virtual void Write (const void *Data, size_t Size)
 Zapisuje dane.
virtual void Flush ()
virtual size_t Read (void *Out, size_t MaxLength)
 Odczytuje dane.
virtual bool End ()
 Tak samo jak MustRead(), ale sama odczytuje rozmiar przekazanej zmiennej.


Opis szczegółowy

Obsługa pliku w formacie gzip (zalecane rozszerzenie ".gz").

Dokumentacja konstruktora i destruktora

common::GzipFileStream::GzipFileStream ( const string &  FileName,
GZIP_FILE_MODE  Mode,
int  Level = ZLIB_DEFAULT_LEVEL 
)

Level ma znaczenie tylko przy zapisie.

virtual common::GzipFileStream::~GzipFileStream (  )  [virtual]


Dokumentacja funkcji składowych

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

Zapisuje dane.

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

Reimplementowana z common::Stream.

virtual void common::GzipFileStream::Flush (  )  [virtual]

Reimplementowana z common::Stream.

virtual size_t common::GzipFileStream::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 bool common::GzipFileStream::End (  )  [virtual]

Tak samo jak MustRead(), ale sama odczytuje rozmiar przekazanej zmiennej.

Zwraca true, jeśli osiągnięto koniec strumienia (W oryginale: zgłasza błąd)

Reimplementowana z common::Stream.


Dokumentacja dla tej klasy została wygenerowana z pliku:

Wygenerowano Sat Mar 29 18:17:03 2008 dla CommonLib programem  doxygen 1.5.5