CPGFFileStream Class Reference

A PGF stream subclass for external storage files. More...

#include <Stream.h>

Inheritance diagram for CPGFFileStream:

[legend]

List of all members.

Public Member Functions
	CPGFFileStream (HANDLE hFile)
	CPGFFileStream ()
virtual	~CPGFFileStream ()
HANDLE	GetHandle ()
virtual UINT64	GetPos () const THROW_
virtual bool	IsValid () const
virtual void	Read (int *count, void *buffer) THROW_
virtual void	SetPos (short posMode, INT64 posOff) THROW_
virtual void	Write (int *count, void *buffer) THROW_
Protected Attributes
HANDLE	m_hFile

---

Detailed Description

A PGF stream subclass for external storage files.

Author:

C. Stamm

Definition at line 74 of file Stream.h.

---

Constructor & Destructor Documentation

CPGFFileStream::CPGFFileStream

(

)

[inline]

Definition at line 79 of file Stream.h.

CPGFFileStream::CPGFFileStream

(

HANDLE

hFile

)

[inline]

Constructor.

Parameters:

hFile

File handle

Definition at line 82 of file Stream.h.

virtual CPGFFileStream::~CPGFFileStream

(

)

[inline, virtual]

Definition at line 86 of file Stream.h.

---

Member Function Documentation

HANDLE CPGFFileStream::GetHandle

(

)

[inline]

Returns:

File handle

Definition at line 84 of file Stream.h.

UINT64 CPGFFileStream::GetPos

(

)

const [virtual]

Get current stream position.

Returns:

Current stream position

Implements CPGFStream.

Definition at line 64 of file Stream.cpp.

virtual bool CPGFFileStream::IsValid

(

)

const [inline, virtual]

Check stream validity.

Returns:

True if stream and current position is valid

Implements CPGFStream.

Definition at line 91 of file Stream.h.

void CPGFFileStream::Read	(	int *	count,
		void *	buffer
	)			[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

Implements CPGFStream.

Definition at line 48 of file Stream.cpp.

void CPGFFileStream::SetPos	(	short	posMode,
		INT64	posOff
	)			[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)

Implements CPGFStream.

Definition at line 57 of file Stream.cpp.

void CPGFFileStream::Write	(	int *	count,
		void *	buffer
	)			[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

Implements CPGFStream.

Definition at line 38 of file Stream.cpp.

---

Member Data Documentation

HANDLE CPGFFileStream::m_hFile [protected]

Definition at line 76 of file Stream.h.

---

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

• Stream.h
• Stream.cpp