IContentReadIterator Class Reference

#include <IContentIterator.h>

Inheritance diagram for IContentReadIterator:

Public Member Functions
virtual	~IContentReadIterator ()
virtual bool16	IsClassID () const =0
virtual ClassID	GetClassID () const =0
virtual ImplementationID	GetImplementationID () const =0
virtual uint32	GetLength () const =0
virtual bool16	Next ()=0
virtual bool16	EndOfList () const =0
virtual void	Reset (IContentWriteIterator *out=nil)=0
virtual int32	GetOriginPosition () const =0
virtual IPMStream *	QueryContentStream ()=0

Detailed Description

This class is used by the Conversion Manager to iterate over the contents of persistent class or implementation's data. This iteration is a read-modify-write operation. IContentReadIterator is used for the output part of the process.

Constructor & Destructor Documentation

virtual IContentReadIterator::~IContentReadIterator ( )

inlinevirtual

Virtual destructor

Member Function Documentation

virtual bool16 IContentReadIterator::EndOfList ( ) const

pure virtual

Returns kTrue when there are no more IDs in the iterated data stream

Returns

kTrue if the data has been exhausted, kFalse if there are more IDs.

Implemented in CContentReadIterator.

virtual ClassID IContentReadIterator::GetClassID ( ) const

pure virtual

Fetch the current Class ID.

Returns

The Class ID.

Implemented in CContentReadIterator.

virtual ImplementationID IContentReadIterator::GetImplementationID ( ) const

pure virtual

Fetch the current Implementation ID.

Returns

The Implementation ID.

Implemented in CContentReadIterator.

virtual uint32 IContentReadIterator::GetLength ( ) const

pure virtual

Return the length (in bytes) of the data associated with the current ID.

Returns

Data length

Implemented in CContentReadIterator.

virtual int32 IContentReadIterator::GetOriginPosition ( ) const

pure virtual

Returns the initial position of the input stream associated with this iterator. That is – the stream's position at the time the iterator was bound to it.

Returns

The original stream position.

Implemented in CContentReadIterator.

virtual bool16 IContentReadIterator::IsClassID ( ) const

pure virtual

Used to determine whether the current ID found in the input stream is a Class ID or an Implementation ID.

Returns

kTrue if the current ID is a Class ID.

Implemented in CContentReadIterator.

virtual bool16 IContentReadIterator::Next ( )

pure virtual

Advance the iterator to the next ID in the input stream.

Returns

kTrue if another ID was found, kFalse if not.

Implemented in CContentReadIterator.

virtual IPMStream* IContentReadIterator::QueryContentStream ( )

pure virtual

Returns an interface pointer to the iterator's associated input stream. The interface is add-refed prior to returning the pointer.

Returns

The stream pointer.

Implemented in CContentReadIterator.

virtual void IContentReadIterator::Reset ( IContentWriteIterator *  out = nil )

pure virtual

Called when the Conversion Manager wishes to reinitalize the iterator. An output iterator may optionall be associated with this input iterator at this time.

Parameters

out	IN Used to bind an output iterator to this input iterator.

Implemented in CContentReadIterator.