All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

XMLParser Interface CATIDOMNodeIterator

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDOMNodeIterator
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDOMNodeIterator

Interface used to step through a set of nodes.
(e.g. the set of nodes in a CATIDOMNodeList, the document subtree governed by a particular CATIDOMNode, the results of a query, or any other set of nodes). The set of nodes to be iterated is determined by the implementation of the CATIDOMNodeIterator. DOM Level 2 specifies a single CATIDOMNodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling CATIDOMDocumentTraversal.CreateNodeIterator.

See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.


Method Index


o Detach()
Detaches the CATIDOMNodeIterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.
o GetExpandEntityReferences(CATBoolean&)
Retrieves the flag which determines whether the children of entity reference nodes are visible to the iterator.
o GetFilter(CATIDOMNodeFilter_var&)
Retrieves the CATIDOMNodeFilter used to screen nodes.
o GetRoot(CATIDOMNode_var&)
Retrieves the root node of the CATIDOMNodeIterator, as specified when it was created.
o GetWhatToShow(unsigned int&)
Retrieves which node types are presented via the iterator.
o NextNode(CATIDOMNode_var&)
Retrieves the next node in the set and advances the position of the iterator in the set.
o PreviousNode(CATIDOMNode_var&)
Retrieves the previous node in the set and moves the position of the CATIDOMNodeIterator backwards in the set.

Methods


o Detach
public virtual HRESULT Detach()= 0
Detaches the CATIDOMNodeIterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. After Detach has been invoked, calls to NextNode or PreviousNode will raise the exception INVALID_STATE_ERR.
o GetExpandEntityReferences
public virtual HRESULT GetExpandEntityReferences(CATBoolean& oResult) = 0
Retrieves the flag which determines whether the children of entity reference nodes are visible to the iterator. If false, they and their descendants will be rejected. Note that this rejection takes precedence over GetWhatToShow and the filter. Also note that this is currently the only situation where CATIDOMNodeIterator instances may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the GetWhatToShow flags to hide the entity reference node and set GetExpandEntityReferences to true when creating the iterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the GetWhatToShow flags to show the entity reference node and set GetExpandEntityReferences to false.
Parameters:
oResult
the flag which determines whether the children of entity reference nodes are visible to the iterator.
o GetFilter
public virtual HRESULT GetFilter(CATIDOMNodeFilter_var& oNodeFilter)= 0
Retrieves the CATIDOMNodeFilter used to screen nodes.
Parameters:
oNodeFilter
the
CATIDOMNodeFilter used to screen nodes.
o GetRoot
public virtual HRESULT GetRoot(CATIDOMNode_var& oRoot) = 0
Retrieves the root node of the CATIDOMNodeIterator, as specified when it was created.
Parameters:
oRoot
The root node of the
CATIDOMNodeIterator
o GetWhatToShow
public virtual HRESULT GetWhatToShow(unsigned int& oType) = 0
Retrieves which node types are presented via the iterator. The available set of constants is defined in the CATIDOMNodeFilter interface. Nodes not accepted by GetWhatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.
Parameters:
oType
The node types which are presented via the iterator
o NextNode
public virtual HRESULT NextNode(CATIDOMNode_var& oNode) = 0
Retrieves the next node in the set and advances the position of the iterator in the set. After a CATIDOMNodeIterator is created, the first call to NextNode returns the first node in the set.
Parameters:
oNode
The next
CATIDOMNode in the set being iterated over, or NULL_var if there are no more members in that set.
Errors Returned:
Error Class Error Id Description
CATDOMException XMLParserERR_2211 INVALID_STATE_ERR: Raised if this method is called after the Detach method was invoked.
o PreviousNode
public virtual HRESULT PreviousNode(CATIDOMNode_var& oNode) = 0
Retrieves the previous node in the set and moves the position of the CATIDOMNodeIterator backwards in the set.
Parameters:
oNode
The previous
CATIDOMNode in the set being iterated over, or NULL_var if there are no more members in that set.
Errors Returned:
Error Class Error Id Description
CATDOMException XMLParserERR_2211 INVALID_STATE_ERR: Raised if this method is called after the Detach method was invoked.

This object is included in the file: CATIDOMNodeIterator.h
If needed, your Imakefile.mk should include the module: CATXMLParserItf

Copyright © 2003, Dassault Systèmes. All rights reserved.