Helper class to maintain a read position whilst extracting data from an IByteChunk. More...

Public Member Functions
	IByteChunkReader (const IByteChunk &chunk, int startPos=0)

int	GetBytes (void *pBuf, int nBytesToCopy)
	Copy `nBytesToCopy` bytes from the managed IByteChunk into `pBuf` . More...

template<class T >
int	Get (T *pDst)
	Copy arbitary typed data out of the managed IByteChunk at the current position and update the position. More...

int	GetStr (WDL_String &str)
	Retrieve a string from the managed IByteChunk and put it in `str` . More...

int	Tell () const
	Return the current position in the managed IByteChunk. More...

void	Seek (int pos)
	Set the current position in the managed IByteChunk. More...

Detailed Description

Helper class to maintain a read position whilst extracting data from an IByteChunk.

Definition at line 331 of file IPlugStructs.h.

Member Function Documentation

template<class T >

int IByteChunkReader::Get ( T * pDst )

inline

Copy arbitary typed data out of the managed IByteChunk at the current position and update the position.

Template Parameters

T	type of the variable to get

Parameters

pDst	Pointer to the destination where the value will be stored

Definition at line 355 of file IPlugStructs.h.

int IByteChunkReader::GetBytes	(	void *	pBuf,
		int	nBytesToCopy
	)

inline

Copy nBytesToCopy bytes from the managed IByteChunk into pBuf .

Parameters

pBuf	Destination buffer
nBytesToCopy	Number of bytes to copy

Definition at line 344 of file IPlugStructs.h.

int IByteChunkReader::GetStr ( WDL_String & str )

inline

Retrieve a string from the managed IByteChunk and put it in str .

Parameters

str	Destination for the string

Definition at line 364 of file IPlugStructs.h.

void IByteChunkReader::Seek ( int pos )

inline

Set the current position in the managed IByteChunk.

Parameters

pos	The new IByteChunk position

Definition at line 379 of file IPlugStructs.h.

int IByteChunkReader::Tell ( ) const

inline

Return the current position in the managed IByteChunk.

Definition at line 372 of file IPlugStructs.h.

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