InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IMetaDataIterator Class Referenceabstract
Inheritance diagram for IMetaDataIterator:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMETADATAITERATOR }
 

Public Member Functions

virtual void Adopt (void *iter)=0
 
virtual bool16 Next (PMString &ns, PMString &path, PMString &prop, IMetaDataAccess::IteratorOptions *options=0) const =0
 
virtual void Skip (IMetaDataAccess::SkipOptions options)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void IMetaDataIterator::Adopt (void * iter)
pure virtual

This should be used by external users, this is used to set the tool kit wrapper

virtual bool16 IMetaDataIterator::Next (PMStringns,
PMStringpath,
PMStringprop,
IMetaDataAccess::IteratorOptionsoptions = 0 
) const
pure virtual

Get the information from the next iteration.

Parameters
schemaNSA pointer to the string that will be assigned the schema namespace URI of the current property. May be null if the value is not wanted.
propPathA pointer to the string that will be assigned the XPath name of the current property. May be null if the value is not wanted.
propValueA pointer to the string that will be assigned the value of the current property. May be null if the value is not wanted.
optionsOption flags describing the current property.
Returns
Returns true if there was another node to visit, false if the iteration is done.
virtual void IMetaDataIterator::Skip (IMetaDataAccess::SkipOptions options)
pure virtual

Skip some portion of the remaining iterations.

Parameters
optionsOption flags to control the iteration. The available option flags are: kIterSkipSubtree - Skip the subtree below the current node. kIterSkipSiblings - Skip the subtree below and remaining siblings of the current node.