## wxStreamBase

This class is the base class of most stream related classes in wxWindows. It must not be used directly.

Derived from

None

Include files

<wx/stream.h>

See also

wxStreamBuffer

Members

wxStreamBase::wxStreamBase
wxStreamBase::~wxStreamBase
wxStreamBase::IsOk
wxStreamBase::LastError
wxStreamBase::OnSysRead
wxStreamBase::OnSysSeek
wxStreamBase::OnSysTell
wxStreamBase::OnSysWrite
wxStreamBase::GetSize

### wxStreamBase::wxStreamBase

wxStreamBase()

Creates a dummy stream object. It doesn't do anything.

### wxStreamBase::~wxStreamBase

~wxStreamBase()

Destructor.

### wxStreamBase::IsOk

wxStreamError IsOk() const

Returns TRUE if no error occurred on the stream.

See also

LastError

### wxStreamBase::LastError

wxStreamError LastError() const

This function returns the last error.

wxSTREAM_NO_ERROR | No error occurred.
wxSTREAM_EOF | An End-Of-File occurred.
wxSTREAM_WRITE_ERROR | A generic error occurred on the last write call.
wxSTREAM_READ_ERROR | A generic error occurred on the last read call.

### wxStreamBase::OnSysRead

size_t OnSysRead(void* buffer, size_t bufsize)

Internal function. It is called when the stream wants to read data of the specified size. It should return the size that was actually read.

### wxStreamBase::OnSysSeek

off_t OnSysSeek(off_t pos, wxSeekMode mode)

Internal function. It is called when the stream needs to change the current position.

### wxStreamBase::OnSysTell

off_t OnSysTell() const

Internal function. Is is called when the stream needs to know the real position.

### wxStreamBase::OnSysWrite

size_t OnSysWrite(void *buffer, size_t bufsize)

See OnSysRead.

### wxStreamBase::GetSize

size_t GetSize() const

This function returns the size of the stream. For example, for a file it is the size of the file.

Warning

There are streams which do not have size by definition, such as socket streams. In that cases, GetSize returns an invalid size represented by

    ~(size_t)0