TPtxSys_StreamDescriptor Struct Reference

Structure that groups a set of callbacks that model streams. More...

#include <PdfTools_Toolbox_PtxSys.h>

Public Attributes
TGetLength	pfGetLength
	Get length of stream in bytes.
TSeek	pfSeek
	Set position.
TTell	pfTell
	Get current byte position.
TRead	pfRead
	Read nSize bytes from stream.
TWrite	pfWrite
	Write nSize bytes to stream.
TRelease	pfRelease
	Release handle.
void *	m_handle
	Stream handle.

Detailed Description

Structure that groups a set of callbacks that model streams.

Member Data Documentation

m_handle

void* TPtxSys_StreamDescriptor::m_handle

Stream handle.

pfGetLength

TGetLength TPtxSys_StreamDescriptor::pfGetLength

Get length of stream in bytes.

pfRead

TRead TPtxSys_StreamDescriptor::pfRead

Read nSize bytes from stream.

Returns

number of bytes read, 0 for end of stream, -1 for an error

pfRelease

TRelease TPtxSys_StreamDescriptor::pfRelease

Release handle.

pfSeek

TSeek TPtxSys_StreamDescriptor::pfSeek

Set position.

Parameters

iPos	byte position, -1 for end of stream

Returns

1 on success, 0 on failure

pfTell

TTell TPtxSys_StreamDescriptor::pfTell

Get current byte position.

Returns

byte position, -1 if position unknown

pfWrite

TWrite TPtxSys_StreamDescriptor::pfWrite

Write nSize bytes to stream.

Returns

number of bytes written, -1 for error (0 is interpreted as error too)

---

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

• include/PdfTools_Toolbox_PtxSys.h