createAttribute Method

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Creates a new attribute with the specified name.

Script Syntax

var objXMLDOMAttribute = oXMLDOMDocument.createAttribute(name);

Remarks

Script Parameters

• name
  String specifying the name of the new attribute object. This name is subsequently available as the new node's nodeName property.

Script Return Value

Object. Returns the new IXMLDOMAttribute object.

C/C++ Syntax

HRESULT createAttribute(
  BSTR name,
  IXMLDOMAttribute** attribute
);

Remarks

C/C++ Parameters

• name
  [in] Name of the new attribute object. This name is subsequently available as the new node's nodeName property.

• attribute
  [out, retval] Address of the new IXMLDOMAttribute object.

C/C++ Return Values

• S_OK
  Value returned if successful.

• E_INVALIDARG
  Value returned if attribute is Null.

• E_FAIL
  Value returned if an error occurs.

Requirements

General Remarks

Creating an attribute with this method is the same as using createNode Method where the type parameter value is NODE_ATTRIBUTE and no namespace is specified.

You cannot create a namespace-qualified attribute using the createAttribute method. Regardless of whether a namespace prefix is included in name, the namespaceURI Property (IXMLDOMNode) property for the new attribute is set to an empty string, "". An attribute constructed as part of an XML document load operation will never have both a prefix and an empty namespace Uniform Resource Identifier (URI). You can only create a namespace-qualified attribute using the createNode Method of the DOMDocument.

No data value is set for the attribute during the create operation. You can set the value by calling the setAttribute method of the element object.

Although this method creates the new object in the context of this document, it does not automatically add the new object to the document tree. In other words, although the ownerDocument property of the new node points to this document object, the parentNode property is set to Null. To associate the attribute with an element, call the setAttribute method of the IXMLDOMElement object.

The nodeType property has the value NODE_ATTRIBUTE.

This method applies to the following objects and interfaces:

DOMDocument, IXMLDOMAttribute, and IXMLDOMElement.

See Also

Concepts

createNode Method
setAttribute Method
namespaceURI Property (IXMLDOMNode)
nodeName Property
nodeType Property
ownerDocument Property
parentNode Property