Scribus
Open source desktop publishing at your fingertips
CPGFFileStream Class Reference

File stream class. More...

#include <PGFstream.h>

Inheritance diagram for CPGFFileStream:
Collaboration diagram for CPGFFileStream:

Public Member Functions

 CPGFFileStream (HANDLE hFile)
 
HANDLE GetHandle ()
 
virtual void Write (int *count, void *buffer) THROW_
 
virtual void Read (int *count, void *buffer) THROW_
 
virtual void SetPos (short posMode, INT64 posOff) THROW_
 
virtual UINT64 GetPos () const THROW_
 
virtual bool IsValid () const
 
- Public Member Functions inherited from CPGFStream
 CPGFStream ()
 Standard constructor.
 
virtual ~CPGFStream ()
 Standard destructor.
 

Protected Attributes

HANDLE m_hFile
 file handle
 

Detailed Description

File stream class.

A PGF stream subclass for external storage files.

Author
C. Stamm

Constructor & Destructor Documentation

CPGFFileStream::CPGFFileStream ( HANDLE  hFile)
inline

Constructor

Parameters
hFileFile handle

Member Function Documentation

HANDLE CPGFFileStream::GetHandle ( )
inline
Returns
File handle
UINT64 CPGFFileStream::GetPos ( ) const
virtual

Get current stream position.

Returns
Current stream position

Implements CPGFStream.

virtual bool CPGFFileStream::IsValid ( ) const
inlinevirtual

Check stream validity.

Returns
True if stream and current position is valid

Implements CPGFStream.

void CPGFFileStream::Read ( int *  count,
void *  buffer 
)
virtual

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

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

Implements CPGFStream.

void CPGFFileStream::SetPos ( short  posMode,
INT64  posOff 
)
virtual

Set stream position either absolute or relative.

Parameters
posModeA position mode (FSFromStart, FSFromCurrent, FSFromEnd)
posOffA new stream position (absolute positioning) or a position offset (relative positioning)

Implements CPGFStream.

void CPGFFileStream::Write ( int *  count,
void *  buffer 
)
virtual

Write some bytes out of a buffer into this stream.

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

Implements CPGFStream.


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