Scroll to navigation

CPGFStream(3)

Library Functions Manual

CPGFStream(3)

NAME¶

CPGFStream - Abstract stream base class.

SYNOPSIS¶

#include <PGFstream.h>

Inherited by CPGFFileStream, and CPGFMemoryStream.

Public Member Functions¶

CPGFStream ()
Standard constructor. virtual ~CPGFStream ()
Standard destructor. virtual void Write (int *count, void *buffer)=0
virtual void Read (int *count, void *buffer)=0
virtual void SetPos (short posMode, INT64 posOff)=0
virtual UINT64 GetPos () const =0
virtual bool IsValid () const =0

Detailed Description¶

Abstract stream base class.

Abstract stream base class.

Author

C. Stamm

Definition at line 39 of file PGFstream.h.

Constructor & Destructor Documentation¶

CPGFStream::CPGFStream () [inline]¶

Standard constructor.

Definition at line 43 of file PGFstream.h..PP

43 {}

virtual CPGFStream::~CPGFStream () [inline], [virtual]¶

Standard destructor.

Definition at line 47 of file PGFstream.h..PP

47 {}

Member Function Documentation¶

virtual UINT64 CPGFStream::GetPos () const [pure virtual]¶

Get current stream position.

Returns

Current stream position

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual bool CPGFStream::IsValid () const [pure virtual]¶

Check stream validity.

Returns

True if stream and current position is valid

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::Read (int * count, void * buffer) [pure virtual]¶

Read some bytes from this stream and stores them into a buffer.

Parameters

count A pointer to a value containing the number of bytes should be read. After this call it contains the number of read bytes.
buffer A memory buffer

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::SetPos (short posMode, INT64 posOff) [pure virtual]¶

Set stream position either absolute or relative.

Parameters

posMode A position mode (FSFromStart, FSFromCurrent, FSFromEnd)
posOff A new stream position (absolute positioning) or a position offset (relative positioning)

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::Write (int * count, void * buffer) [pure virtual]¶

Write some bytes out of a buffer into this stream.

Parameters

count A pointer to a value containing the number of bytes should be written. After this call it contains the number of written bytes.
buffer A memory buffer

Implemented in CPGFFileStream, and CPGFMemoryStream.

Author¶

Generated automatically by Doxygen for libpgf from the source code.

Version 7.21.2

libpgf