createEntityReference Method (Compact 2013)

  • Article

3/26/2014

Creates a new EntityReference object.

Syntax

var objXMLDOMEntityReference = oXMLDOMDocument.createEntityReference(name);

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

Parameters

Script

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

C/C++

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

Return Value

Script

Object. Returns the new IXMLDOMEntityReference object.

C/C++

  • 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 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.

This method applies to the following objects and interfaces:

DOMDocument and IXMLDOMEntityReference.

Requirements

Header

msxml2.h,
msxml2.idl

Library

uuid.lib

See Also

Reference

XML DOM Methods
createNode Method
insertBefore Method
replaceChild Method
nodeName Property
nodeType Property
ownerDocument Property
parentNode Property