Stream Class Reference

#include <Stream.h>

Inherited by File.

Public Types
enum	EStreamFrom { FromStart = 0 , FromMarker , FromEnd }

Public Member Functions
virtual UInt32	GetLength (void)=0
	Get the length of the stream.
virtual void	SetLength (UInt32 length)=0
	Set the length of the stream.
virtual UInt32	GetMarker (void)=0
	Get current position of stream marker.
virtual void	SetMarker (Int32 offset, EStreamFrom from)=0
	Set position of stream marker.
virtual bool	AtEnd (void)=0
	End of stream test.
virtual UInt32	GetBytes (void *ptr, UInt32 bytes)=0
	Retrieve a sequence of bytes.
virtual UInt32	PutBytes (const void *ptr, UInt32 bytes)=0
	Write a sequence of bytes.
virtual UInt32	PeekBytes (void *ptr, UInt32 bytes)=0
	Retrieve a sequence of bytes without advancing marker.
virtual void	Flush (void)=0
	Flush the stream.

Detailed Description

Definition at line 42 of file Stream.h.

Member Enumeration Documentation

EStreamFrom

enum Stream::EStreamFrom

Enumerator
FromStart
FromMarker
FromEnd

Definition at line 46 of file Stream.h.

Member Function Documentation

AtEnd()

virtual bool Stream::AtEnd ( void )

pure virtual

End of stream test.

Implemented in File.

Flush()

virtual void Stream::Flush ( void )

pure virtual

Flush the stream.

Implemented in File.

GetBytes()

virtual UInt32 Stream::GetBytes ( void * ptr, UInt32 bytes )

pure virtual

Retrieve a sequence of bytes.

Implemented in File.

GetLength()

virtual UInt32 Stream::GetLength ( void )

pure virtual

Get the length of the stream.

Implemented in File.

GetMarker()

virtual UInt32 Stream::GetMarker ( void )

pure virtual

Get current position of stream marker.

Implemented in File.

PeekBytes()

virtual UInt32 Stream::PeekBytes ( void * ptr, UInt32 bytes )

pure virtual

Retrieve a sequence of bytes without advancing marker.

Implemented in File.

PutBytes()

virtual UInt32 Stream::PutBytes ( const void * ptr, UInt32 bytes )

pure virtual

Write a sequence of bytes.

Implemented in File.

SetLength()

virtual void Stream::SetLength ( UInt32 length )

pure virtual

Set the length of the stream.

Implemented in File.

SetMarker()

virtual void Stream::SetMarker ( Int32 offset, EStreamFrom from )

pure virtual

Set position of stream marker.

Implemented in File.

---

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

• Code/Tools/Launcher/Toolkit/Storage/Stream.h