The base interface for the IInputStream and IOutputStream interfaces. More...
#include <IStreamBase.hpp>
Inheritance diagram for WCL::IStreamBase:
Public Types | |
| enum | SeekPos { BEGIN = FILE_BEGIN, CURRENT = FILE_CURRENT, END = FILE_END } |
| The relative file position to seek from. More... | |
Public Member Functions | |
| virtual uint32 | Format () const =0 |
| Get the stream contents format. | |
| virtual void | SetFormat (uint32 nFormat)=0 |
| Set the stream contents format. | |
| virtual uint32 | Version () const =0 |
| Get the stream contents version. | |
| virtual void | SetVersion (uint32 nVersion)=0 |
| Set the stream contents version. | |
| virtual StreamPos | Seek (StreamPos lPos, SeekPos eFrom=BEGIN)=0 |
| Move the stream pointer. | |
| virtual void | Throw (int eErrCode, DWORD dwLastError)=0 |
| Throw a stream specific exception with the specified error code. | |
Protected Member Functions | |
| virtual | ~IStreamBase () |
| Protected destructor. | |
Detailed Description
The base interface for the IInputStream and IOutputStream interfaces.
This interface allows a format and version number to be associated with the stream so that lower-level code can handle schema changes.
Member Enumeration Documentation
Constructor & Destructor Documentation
| virtual WCL::IStreamBase::~IStreamBase | ( | ) | [inline, protected, virtual] |
Protected destructor.
Member Function Documentation
| virtual uint32 WCL::IStreamBase::Format | ( | ) | const [pure virtual] |
Get the stream contents format.
Implemented in CStream.
| virtual void WCL::IStreamBase::SetFormat | ( | uint32 | nFormat | ) | [pure virtual] |
Set the stream contents format.
Implemented in CStream.
| virtual uint32 WCL::IStreamBase::Version | ( | ) | const [pure virtual] |
Get the stream contents version.
Implemented in CStream.
| virtual void WCL::IStreamBase::SetVersion | ( | uint32 | nVersion | ) | [pure virtual] |
Set the stream contents version.
Implemented in CStream.
| virtual StreamPos WCL::IStreamBase::Seek | ( | StreamPos | lPos, |
| SeekPos | eFrom = BEGIN |
||
| ) | [pure virtual] |
Move the stream pointer.
Implemented in CClipboard, CFile, and CMemStream.
| virtual void WCL::IStreamBase::Throw | ( | int | eErrCode, |
| DWORD | dwLastError | ||
| ) | [pure virtual] |
Throw a stream specific exception with the specified error code.
Implemented in CClipboard, CFile, and CMemStream.
The documentation for this class was generated from the following file:
