|  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
 | | |  |  |  | 
 DOMNamedNodeMap Class ReferenceDOMNamedNodeMaps are used to represent collections of nodes that can be accessed by name.  
More...
List of all members. 
 Detailed DescriptionDOMNamedNodeMaps are used to represent collections of nodes that can be accessed by name.
Note that DOMNamedNodeMapdoes not inherit fromDOMNodeList;DOMNamedNodeMaps are not maintained in any particular order. Nodes contained in aDOMNamedNodeMapmay also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents, and does not imply that the DOM specifies an order to these Nodes. 
 Since:DOM Level 1 
 
 
 Constructor & Destructor Documentation
 
  
    | 
        
          | DOMNamedNodeMap::DOMNamedNodeMap | ( |  | ) |  [protected] |  |  
 
 Member Function Documentation
 
  
    | 
        
          | virtual XMLSize_t DOMNamedNodeMap::getLength | ( |  | ) | const  [pure virtual] |  |  
  
    |  | 
The number of nodes in the map. 
 
The range of valid child node indices is 0 to length-1inclusive. Since:DOM Level 1 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::getNamedItem | ( | const XMLCh * | name | ) | const  [pure virtual] |  |  
  
    |  | 
Retrieves a node specified by name. 
 
 Parameters:
  
    |  | name | The nodeNameof a node to retrieve. | 
 Returns:A DOMNode(of any type) with the specifiednodeName, ornullif it does not identify any node in the map.
 Since:DOM Level 1 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::getNamedItemNS | ( | const XMLCh * | namespaceURI, |  
          |  |  | const XMLCh * | localName |  
          |  | ) | const  [pure virtual] |  |  
  
    |  | 
Retrieves a node specified by local name and namespace URI. 
 
 Parameters:
  
    |  | namespaceURI | The namespace URI of the node to retrieve. |  |  | localName | The local name of the node to retrieve. | 
 Returns:A DOMNode(of any type) with the specified local name and namespace URI, ornullif they do not identify any node in the map.
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::item | ( | XMLSize_t | index | ) | const  [pure virtual] |  |  
  
    |  | 
Returns the indexth item in the map. 
If indexis greater than or equal to the number of nodes in the map, this returnsnull. Parameters:
  
    |  | index | Index into the map. | 
 Returns:The node at the indexth position in theDOMNamedNodeMap, ornullif that is not a valid index.
 Since:DOM Level 1 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::removeNamedItem | ( | const XMLCh * | name | ) |  [pure virtual] |  |  
  
    |  | 
Removes a node specified by name. 
 
If the removed node is an DOMAttrwith a default value it is immediately replaced. Parameters:
  
    |  | name | The nodeNameof a node to remove. | 
 Returns:The node removed from the map if a node with such a name exists. 
 Exceptions:
  
    |  | DOMException | NOT_FOUND_ERR: Raised if there is no node named namein the map.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 DOMNamedNodeMapis readonly. | 
 Since:DOM Level 1 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::removeNamedItemNS | ( | const XMLCh * | namespaceURI, |  
          |  |  | const XMLCh * | localName |  
          |  | ) |  [pure virtual] |  |  
  
    |  | 
Removes a node specified by local name and namespace URI. 
 
 Parameters:
  
    |  | namespaceURI | The namespace URI of the node to remove. |  |  | localName | The local name of the node to remove. When this DOMNamedNodeMapcontains the attributes attached to an element, as returned by the attributes attribute of theDOMNodeinterface, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix. | 
 Returns:The node removed from the map if a node with such a local name and namespace URI exists. 
 Exceptions:
  
    |  | DOMException | NOT_FOUND_ERR: Raised if there is no node named namein the map.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 DOMNamedNodeMapis readonly. | 
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::setNamedItem | ( | DOMNode * | arg | ) |  [pure virtual] |  |  
  
    |  | 
Adds a node using its nodeNameattribute. 
As the
 nodeNameattribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased. Parameters:
  
    |  | arg | A node to store in a named node map. The node will later be accessible using the value of the nodeNameattribute of the node. If a node with that name is already present in the map, it is replaced by the new one. | 
 Returns:If the new DOMNodereplaces an existing node the replacedDOMNodeis returned, otherwisenullis returned.
 Exceptions:
  
    |  | DOMException | WRONG_DOCUMENT_ERR: Raised if argwas created from a different document than the one that created theDOMNamedNodeMap.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 DOMNamedNodeMapis readonly.INUSE_ATTRIBUTE_ERR: Raised if
 argis anDOMAttrthat is already an attribute of anotherDOMElementobject. The DOM user must explicitly cloneDOMAttrnodes to re-use them in other elements. | 
 Since:DOM Level 1 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNamedNodeMap::setNamedItemNS | ( | DOMNode * | arg | ) |  [pure virtual] |  |  
  
    |  | 
Adds a node using its namespaceURIandlocalName. 
 Parameters:
  
    |  | arg | A node to store in a named node map. The node will later be accessible using the value of the namespaceURIandlocalNameattribute of the node. If a node with those namespace URI and local name is already present in the map, it is replaced by the new one. | 
 Returns:If the new DOMNodereplaces an existing node the replacedDOMNodeis returned, otherwisenullis returned.
 Exceptions:
  
    |  | DOMException | WRONG_DOCUMENT_ERR: Raised if argwas created from a different document than the one that created theDOMNamedNodeMap.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 DOMNamedNodeMapis readonly.INUSE_ATTRIBUTE_ERR: Raised if
 argis anDOMAttrthat is already an attribute of anotherDOMElementobject. The DOM user must explicitly cloneDOMAttrnodes to re-use them in other elements. | 
 Since:DOM Level 2 
 |  The documentation for this class was generated from the following file:
 | 
 
 | 
 |