createNode Method (Compact 2013)

  • Article

3/26/2014

Creates a node using the supplied type, name, and namespace.

Syntax

var objXMLDOMNode = oXMLDOMDocument.createNode(Type, name, namespaceURI);

HRESULT createNode(
  VARIANT Type,
  BSTR name,
  BSTR namespaceURI,
  IXMLDOMNode** node
);

Parameters

Script

  • Type
    Variant. Value that uniquely identifies the node type. This can be specified using either the integer value or the string value. For the complete list of values, see XML DOM Enumerated Constants or the description for the name parameter.
  • name
    String containing the value for the new node's nodeName property. The relationship between the node name and node type is summarized below.
  • namespaceURI
    String defining the namespace Uniform Resource Identifier (URI). If specified, the node is created in the context of the namespaceURI with the prefix specified on the node name. If the name parameter does not have a prefix, this is treated as the default namespace.

C/C++

  • Type
    [in] Value that uniquely identifies the node type. This can be specified using either the integer value or the string value. For the complete list of values, see the XML DOM Enumerated Constants or the description given for the name parameter.
  • name
    [in] Value for the new node's nodeName property. The relationship between the node name and node type is summarized in the table below.
  • namespaceURI
    [in] Namespace URI. If specified, the node is created in the context of the namespaceURI parameter with the prefix specified on the node name. If the name parameter does not have a prefix, this is treated as the default namespace.
  • node
    [out, retval] Newly created node.

Return Value

Script

Object. Returns the newly created node.

C/C++

  • S_OK
    Value returned if successful.
  • E_INVALIDARG
    Value returned if node is Null.
  • E_FAIL
    Value returned if an error occurs.

Remarks

The name parameter depends on the value of the type parameter:

Value

Description

NODE_ATTRIBUTE

The name of the attribute.

NODE_CDATA_SECTION, NODE_COMMENT, NODE_DOCUMENT, NODE_DOCUMENT_FRAGMENT, NODE_TEXT

The nodeName property for these node types is a constant value; the name parameter is ignored.

NODE_DOCUMENT_TYPE

The name of the document type; for example, the xxx in <!DOCTYPE xxx ...>.

NODE_ELEMENT

The name of the XML tag, with any namespace prefix included if present.

NODE_ENTITY

The name of the entity.

NODE_ENTITY_REFERENCE

The name of the entity referenced. Note that the name does not include the leading ampersand or the trailing semicolon. The name includes the namespace if one is present.

NODE_NOTATION

The name of the notation.

NODE_PROCESSING_INSTRUCTION

The target, the first token following the <? characters.

You cannot create a node of type NODE_DOCUMENT, NODE_DOCUMENT_TYPE, NODE_ENTITY, or NODE_NOTATION.

When a node is created, it is created in the context of a namespace if one is supplied (if the namespaceURI parameter is supplied). If one is not supplied, the node is created in the namespace of the document. If namespaceURI is specified, the node is created in the context of the namespaceURI with the prefix specified on the node name.

For node types that do not have names, the empty string, "", should be passed as the name parameter.

For elements and entity references, when the namespaceURI parameter is anything other than "" and the name parameter does not contain a prefix (xxx in xxx:yyy), the namespaceURI is treated as the default namespace.

Attributes cannot be scoped to a default namespace, and other elements are not qualified to a particular namespace; they are treated as being from the namespace defined by the document itself.

When namespaceURI is the empty string, "", the node is created within the special namespace of the current document. Creating a qualified node without specifying a nonempty namespaceURI returns an error. This member is an extension of the World Wide Web Consortium (W3C) Document Object Model (DOM).

This method applies to the following interface:

DOMDocument.

Requirements

Header

msxml2.h,
msxml2.idl

Library

uuid.lib

See Also

Reference

XML DOM Methods
XML DOM Enumerated Constants
nodeName Property