Microsoft XML 2.5 SDK


 

IXMLDOMDocument::createAttribute Method

[This is preliminary documentation and subject to change.]

Creates a new attribute with the specified name.

Visual Basic Syntax

Set objXMLDOMAttribute = oXMLDOMDocument.createAttribute(name)

C/C++ Syntax

HRESULT createAttribute(

    BSTR name,

    IXMLDOMAttribute **attribute);

Parameters

name

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

attribute

[out]
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.

Remarks

Creating an attribute with this method is the same as using createNode where the Type parameter 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 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 URI. You can only create a namespace-qualified attribute using the IXMLDOMDocument interface's createNode method.

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

Although this method creates the new object in the context of this document, this method 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 IXMLDOMElement object's setAttribute method.

The nodeType property has the value NODE_ATTRIBUTE.