IDOMDocument::createEntityReference Method

Creates a new entity reference object.

Syntax

HRESULT createEntityReference(
    BSTR name,
    IDOMEntityReference ** 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 IDOMEntityReference object.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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.
Note that you cannot specify a namespace within the name parameter. If the name is specified in the form xxx:yyy, the colon is ignored and the entity reference is created in the namespace of the document. The nameSpace property, which contains the namespace URI, is set to the empty string, "".