createEntityReference Method

 

Creates a new EntityReference object.

JScript Syntax

var objXMLDOMEntityReference = oXMLDOMDocument.createEntityReference(name);  

Parameters

name
A string specifying the name of the entity referenced. This name is subsequently available as the new object's nodeName property.

Return Value

An object. Returns the new IXMLDOMEntityReference object.

Example

The following script example creates a new IXMLDOMEntityReference object and appends it to an IXMLDOMNode object.

var xmlDoc = new ActiveXObject("Msxml2.DOMDocument.6.0");  
var root;  
var MyEntity;  
xmlDoc.async = false;  
xmlDoc.loadXML("<root><child/></root>");  
if (xmlDoc.parseError.errorCode != 0) {  
   var myErr = xmlDoc.parseError;  
   WScript.Echo("You have error " + myErr.reason);  
} else {  
   root = xmlDoc.documentElement;  
   MyEntity = xmlDoc.createEntityReference("newRef");  
   root.childNodes.item(0).appendChild(MyEntity);  
   WScript.Echo(root.xml);  
}  

Output

<root><child>&newRef;</child></root>  

C/C++ Syntax

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

Parameters

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

entityRef[out, retval]
The address of the new IXMLDOMEntityReference object.

C/C++ Return Values

S_OK
The value returned if successful.

E_INVALIDARG
The value returned if the entityRef parameter is Null.

E_FAIL
The value returned if an error occurs.

Remarks

Creating an entity reference with this method is the same as using createNode 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, 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 add the new object, you must explicitly call one of the node insert methods, insertBefore method, replaceChild method, or appendChild method.

The nodeType property has the value NODE_ENTITY_REFERENCE.

Versioning

Implemented in: MSXML 3.0 and MSXML 6.0

Applies to

IXMLDOMDocument-DOMDocument

See Also

nodeName Property1
nodeType Property1
createNode Method
ownerDocument Property
parentNode Property1
insertBefore Method
replaceChild Method
appendChild Method
IXMLDOMEntityReference