PDFix SDK  6.5.0
PdsStream Struct Referenceabstract

PdsStream class. More...

Inheritance diagram for PdsStream:
PdsObject

Public Member Functions

virtual PdsDictionaryGetStreamDict ()=0
 Gets the stream dictionary object. More...
 
virtual int GetRawDataSize ()=0
 Gets the stream raw data size. More...
 
virtual bool IsEof ()=0
 Checks if the current position is end of stream. More...
 
virtual int GetSize ()=0
 Gets the current size of a stream. More...
 
virtual bool Read (int offset, uint8_t *buffer, int size)=0
 Reads data from PsStream into memory. More...
 
virtual int GetPos ()=0
 
- Public Member Functions inherited from PdsObject
virtual PdfObjectType GetObjectType ()=0
 Gets the type of an object. More...
 
virtual int GetId ()=0
 Gets the object number. More...
 

Detailed Description

PdsStream class.

Member Function Documentation

◆ GetPos()

virtual int PdsStream::GetPos ( )
pure virtual

Gets the current seek position in a stream. This is the position at which the next read or write will begin.

Returns
The current seek position.

◆ GetRawDataSize()

virtual int PdsStream::GetRawDataSize ( )
pure virtual

Gets the stream raw data size.

Returns
The stream's dictionary

◆ GetSize()

virtual int PdsStream::GetSize ( )
pure virtual

Gets the current size of a stream.

Returns
The size of the stream.

◆ GetStreamDict()

virtual PdsDictionary* PdsStream::GetStreamDict ( )
pure virtual

Gets the stream dictionary object.

Returns
The stream's dictionary

◆ IsEof()

virtual bool PdsStream::IsEof ( )
pure virtual

Checks if the current position is end of stream.

Returns
The size of the stream.
See also
PsStream::Read

◆ Read()

virtual bool PdsStream::Read ( int  offset,
uint8_t *  buffer,
int  size 
)
pure virtual

Reads data from PsStream into memory.

Parameters
buffer(Filled by the method) A buffer into which data is written.
offsetThe position to start read from.
sizeThe number of bytes to read.
Returns
true if the operation was successful, false otherwise.