Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

Creates a new EntityReferenceobject.

Script Syntax

Copy Code 
var objXMLDOMEntityReference =
oXMLDOMDocument.createEntityReference(
name);

Remarks

Script Parameters

name

String specifying the name of the entity referenced. This name is subsequently available as the new object's nodeNameproperty.

Script Return Value

Object. Returns the new IXMLDOMEntityReferenceobject.

C/C++ Syntax

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

Remarks

C/C++ Parameters

name

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

entityRef

[out, retval] Address of the new IXMLDOMEntityReferenceobject.

C/C++ Return Values

S_OK

Value returned if successful.

E_INVALIDARG

Value returned if entityRefis Null.

E_FAIL

Value returned if an error occurs.

Requirements

Header msxml2.h, msxml2.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later

General Remarks

Creating an entity reference with this method is the same as using createNodewhere the typeparameter value is NODE_ENTITY_REFERENCE and no namespace is specified. You cannot specify a namespace within the nameparameter.

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 ownerDocumentproperty of the new node points to this document object, the parentNodeproperty is set to Null. To add the new object, you must explicitly call one of the node insert methods, insertBeforemethod, replaceChildmethod, or appendChild Method.

The nodeTypeproperty has the value NODE_ENTITY_REFERENCE.

This method applies to the following objects and interfaces:

DOMDocumentand IXMLDOMEntityReference.

See Also