Script 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.5.0");
var root;
var MyEntity;
xmlDoc.async = false;
xmlDoc.load("books.xml");
if (xmlDoc.parseError.errorCode <> 0) {
   var myErr = xmlDoc.parseError;
   alert("You have error " + myErr.reason);
} else {
   root = xmlDoc.documentElement;
   MyEntity = xmlDoc.createEntityReference("newRef");
   root.childNodes.item(0).appendChild(MyEntity);
   alert(root.xml);
}

Visual Basic Syntax

Set 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 Visual Basic example creates a new IXMLDOMEntityReference object and appends it to an IXMLDOMNode object.

Dim xmlDoc As New Msxml2.DOMDocument50
Dim root As IXMLDOMElement
Dim MyEntity As IXMLDOMEntityReference
xmlDoc.async = False
xmlDoc.Load ("books.xml")
If (xmlDoc.parseError.errorCode <> 0) Then
   Dim myErr
   Set myErr = xmlDoc.parseError
   MsgBox("You have error " & myErr.reason)
Else
   Set root = xmlDoc.documentElement
   Set MyEntity = xmlDoc.createEntityReference("newRef")
   root.childNodes.Item(0).appendChild MyEntity
   MsgBox root.xml
End If

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.