This class is the base class of most stream related classes in wxWidgets. It must not be used directly.
Derived from
None
Include files
<wx/stream.h>
See also
Members
wxStreamBase::wxStreamBase
wxStreamBase::~wxStreamBase
wxStreamBase::GetLength
wxStreamBase::GetLastError
wxStreamBase::GetSize
wxStreamBase::IsOk
wxStreamBase::IsSeekable
wxStreamBase::OnSysRead
wxStreamBase::OnSysSeek
wxStreamBase::OnSysTell
wxStreamBase::OnSysWrite
wxStreamBase()
Creates a dummy stream object. It doesn't do anything.
~wxStreamBase()
Destructor.
wxFileOffset GetLength() const
Returns the length of the stream in bytes. If the length cannot be determined (this is always the case for socket streams for example), returns wxInvalidOffset.
This function is new since wxWidgets version 2.5.4
wxStreamError GetLastError() 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. |
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 0 so you should always test its return value.
bool IsOk() const
Returns true if no error occurred on the stream.
See also
bool IsSeekable() const
Returns true if the streams supports seeking to arbitrary offsets.
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.
off_t OnSysSeek(off_t pos, wxSeekMode mode)
Internal function. It is called when the stream needs to change the current position.
off_t OnSysTell() const
Internal function. Is is called when the stream needs to know the real position.
size_t OnSysWrite(void *buffer, size_t bufsize)
See OnSysRead.