IXMLDOMDocument::createEntityReference Method

---

Creates a new entity reference object.

Visual Basic Syntax

Set objXMLDOMEntityReference = oXMLDOMDocument.createEntityReference(name)

C/C++ Syntax

HRESULT createEntityReference(
    BSTR name,
    IXMLDOMEntityReference **entityRef);

Parameters

name

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

entityRef

[out] Address of the new IXMLDOMEntityReference object.

C/C++ Return Values

S_OK

Value returned if successful.

E_INVALIDARG

Value returned if entityRef is null.

E_FAIL

Value returned if an error occurs.

Remarks

Creating an entity reference with this method is the same as using createNode method where the Type parameter value is NODE_ENTITY_REFERENCE and no namespace is specified. You cannot specify a namespace within the name parameter.

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. You must explicitly call one of the node insert methods—insertBefore, replaceChild, or appendChild—to add the new object.

The nodeType has the value NODE_ENTITY_REFERENCE.