head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.37; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.51; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.53.59; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.55; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# gzfilebuf Class Reference

A C++ I/O streams interface to the zlib gz* functions. More...

`#include <zfstream.hxx>`

List of all members.

## Public Types
typedef char_traits< char > | traits_type
typedef char_traits< char >::int_type | int_type
## Public Methods
| gzfilebuf ()
| Constructor.
virtual | ~gzfilebuf ()
| Destructor.
gzfilebuf * | open (const char *name, ios_openmode io_mode)
| Open a stream.
gzfilebuf * | attach (int file_descriptor, ios_openmode io_mode)
| Attach to an existing file descriptor.
gzfilebuf * | close ()
| Close stream.
bool | is_open () const
virtual streampos | seekoff (streamoff off, ios_seekdir way, int which)
virtual int | sync ()
| sync the stream
## Protected Methods
virtual int_type | underflow ()
virtual int_type | overflow (int_type c=traits_type::eof())

## Detailed Description

A C++ I/O streams interface to the zlib gz* functions.

Definition at line 97 of file zfstream.hxx.

## Member Function Documentation

gzfilebuf * gzfilebuf::attach | ( | int | file_descriptor,
|  | ios_openmode | io_mode
| ) |

  | Attach to an existing file descriptor. Parameters:
  file_descriptor | file descriptor
  io_mode | mode flags
Returns: file stream Definition at line 130 of file zfstream.cxx. References is_open(). Referenced by sg_gzifstream::attach(), and sg_gzifstream::sg_gzifstream().

bool gzfilebuf::is_open | ( |  | ) | const`[inline]`

| Returns: true if open, false otherwise Definition at line 137 of file zfstream.hxx. Referenced by attach(), close(), sg_gzifstream::is_open(), open(), sg_gzifstream::open(), and sync().

gzfilebuf * gzfilebuf::open | ( | const char * | name,
|  | ios_openmode | io_mode
| ) |

  | Open a stream. Parameters:
  name | file name
  io_mode | mdoe flags
Returns: file stream Definition at line 111 of file zfstream.cxx. References is_open(). Referenced by sg_gzifstream::open().

streampos gzfilebuf::seekoff | ( | streamoff | off,
|  | ios_seekdir | way,
|  | int | which
| ) | `[virtual]`

| Returns: stream position Definition at line 179 of file zfstream.cxx.

The documentation for this class was generated from the following files:

- zfstream.hxx
- zfstream.cxx

@ 1.3 log @Oops, try again. @ text @d248 1 a248 1