IXMLDOMNode::get_definition Method

Returns the definition of the node in the DTD or schema.

Visual Basic Syntax

Set objXMLDOMNode = oXMLDOMNode.definition

C/C++ Syntax

HRESULT get_definition(
    IXMLDOMNode **definitionNode);

Parameters

definitionNode
[out] Node that contains the definition for the entity referenced.

C/C++ Return Values

S_OK
Value returned if successful.
S_FALSE
Value when returning null.

E_INVALIDARG
Value returned if definitionNode is null.

Remarks

This value depends on the value of the nodeType property.

NODE_ENTITY_REFERENCE
Returns the node for the entity referenced; that is, returns the ENTITY element that was defined for a given ENTITYREF. Given the ENTITYREF &x;, for example, the definition property returns the node in the DOCTYPE node's entity collection that defines the corresponding ENTITY: <!ENTITY x "y">.

NODE_ENTITY
For unparsed entities, returns the NOTATION definition from the DOCTYPE node's notation collection. For example, given the ENTITY <!ENTITY networth SYSTEM "networth.xls" NDATA XLS>, the definition property returns the node corresponding to the notation <!NOTATION XLS PUBLIC "http://www.microsoft.com/office/excel/">. For parsed entities, returns NULL.

NODE_ATTRIBUTE
Returns the XML-Data Schema AttributeType for a given ATTRIBUTE node. For example, the definition property for the attribute myAttribute="123" returns the node corresponding to the element <AttributeType name="myAttribute"> in the schema. Returns NULL when a DTD (document type definition) is used or when no schema is present.

NODE_ELEMENT
Returns the XML-Data Schema ElementType for a given ELEMENT node. For example, given the element <myelement>, the definition property returns the node <ElementType name="myelement"> in the specified external schema. Returns NULL when a DTD is used or when no schema is present.

NODE_CDATA_SECTION,
NODE_COMMENT,
NODE_DOCUMENT,
NODE_DOCUMENT_FRAGMENT,
NODE_DOCUMENT_TYPE,
NODE_NOTATION,
NODE_PROCESSING_INSTRUCTION,
NODE_TEXT
Returns NULL.

This member is an extension of the W3C DOM.

NODE_ENTITY_REFERENCE	Returns the node for the entity referenced; that is, returns the ENTITY element that was defined for a given ENTITYREF. Given the ENTITYREF &x;, for example, the definition property returns the node in the DOCTYPE node's entity collection that defines the corresponding ENTITY: <!ENTITY x "y">.
NODE_ENTITY	For unparsed entities, returns the NOTATION definition from the DOCTYPE node's notation collection. For example, given the ENTITY <!ENTITY networth SYSTEM "networth.xls" NDATA XLS>, the definition property returns the node corresponding to the notation <!NOTATION XLS PUBLIC "http://www.microsoft.com/office/excel/">. For parsed entities, returns NULL.
NODE_ATTRIBUTE	Returns the XML-Data Schema AttributeType for a given ATTRIBUTE node. For example, the definition property for the attribute myAttribute="123" returns the node corresponding to the element <AttributeType name="myAttribute"> in the schema. Returns NULL when a DTD (document type definition) is used or when no schema is present.
NODE_ELEMENT	Returns the XML-Data Schema ElementType for a given ELEMENT node. For example, given the element <myelement>, the definition property returns the node <ElementType name="myelement"> in the specified external schema. Returns NULL when a DTD is used or when no schema is present.
NODE_CDATA_SECTION, NODE_COMMENT, NODE_DOCUMENT, NODE_DOCUMENT_FRAGMENT, NODE_DOCUMENT_TYPE, NODE_NOTATION, NODE_PROCESSING_INSTRUCTION, NODE_TEXT	Returns NULL.