definition Property

Script Syntax

var objXMLDOMNode = oXMLDOMNode.definition;

Visual Basic Syntax

Set objXMLDOMNode = oXMLDOMNode.definition

C/C++ Syntax

HRESULT get_definition(
    IXMLDOMNode **definitionNode);

Parameters

definitionNode [out, retval]

The node that contains the definition for the entity referenced.

C/C++ Return Values

S_OK

The value returned if successful.

S_FALSE

The value returned when no definition is found.

E_INVALIDARG

The value returned if the definitionNode parameter is Null.

Example

The following C/C++ example shows the retrieval of the definition property from an IXMLDOMElement.

#import "msxml3.dll"
using namespace MSXML2;

#define CHECK_AND_RELEASE(pInterface)  \
if(pInterface) \
   {\
pInterface->Release();\
pInterface = NULL;\
   }\

#define RELEASE(pInterface)  \
   {\
pInterface->Release();\
pInterface = NULL;\
   }\

BOOL DOMNodeGetDefinition()
{
   BOOL bResult = FALSE;
   BSTR bstrValue;
   IXMLDOMElement *pIXMLDOMElement = NULL;
   IXMLDOMNode *pIXMLDOMNode = NULL;
   IXMLDOMDocument2 *pIXMLDOMDocument = NULL;
   HRESULT hr;

   try
   {
      // Create the document and initialize pIXMLDOMDocument.
      // Load the document (sample.xml).
      // Get the documents root.
      hr = pIXMLDOMDocument->get_documentElement(&pIXMLDOMElement);
      SUCCEEDED(hr) ? 0 : throw hr;

      if(pIXMLDOMElement)
      {
         hr = pIXMLDOMElement->get_definition(&pIXMLDOMNode);
         if(SUCCEEDED(hr) && pIXMLDOMNode)
         {
            hr = pIXMLDOMNode->get_xml(&bstrValue);
            if(SUCCEEDED(hr) && bstrValue)
            {
               ::MessageBox(NULL, bstrValue, _T("Definition"), MB_OK);
               ::SysFreeString(bstrValue);
               bResult = TRUE;
            }
            RELEASE(pIXMLDOMNode);
         }
         RELEASE(pIXMLDOMElement);
      }
   }
   catch(...)
   {
      if(bstrValue)
         ::SysFreeString(bstrValue);
      CHECK_AND_RELEASE(pIXMLDOMNode);
      CHECK_AND_RELEASE(pIXMLDOMElement);
      // Release the DOMDocument.
      DisplayErrorToUser();
   }
   // Release the document when finished with it.
   return bResult;
}

Sample.xml

<?xml version="1.0"?> 
<SomeDoc xmlns="x-schema:collschema.xml"> 
   <SomeElement Id="first1"> 
   </SomeElement> 
</SomeDoc> 

collschema.xml

<?xml version='1.0'?>
<Schema xmlns="urn:schemas-microsoft-com:xml-data" 
       xmlns:dt="urn:schemas-microsoft-com:datatypes"> 
   <AttributeType name='Id' dt:type="id"/> 
   <ElementType name='SomeElement' content="mixed" model="open"> 
      <attribute type='Id'/> 
   </ElementType> 

   <ElementType name='SomeDoc' content="mixed" model="open"> 
      <attribute type='Id'/> 
      <element type='SomeElement' minOccurs='1' maxOccurs='*'/> 
   </ElementType> 
</Schema> 

Output (in a message box)

<ElementType name='SomeDoc' content="mixed" model="open"> 
   <attribute type='Id'/> 
   <element type='SomeElement' minOccurs='1' maxOccurs='*'/> 
</ElementType>