MIXmlDocumentGetRootNode() function - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
ft:locale
en-US
Product name
MapBasic
ft:title
MapInfo MapBasic Reference
First publish date
1985
ft:lastEdition
2023-09-12
ft:lastPublication
2023-09-12T16:32:32.686000

Purpose

Retrieves the root element of the document.

Syntax

MIXmlDocumentGetRootNode( ByVal hXMLDocument As MIXmlDocument ) 
	As MIXmlNode

hXMLDocument is the MIXmlDocument object handle.

Return Value

A handle to an MIXmlNode object representing the root element of the document if successful; otherwise NULL.

Description

MIXmlDocumentGetRootNode() retrieves a handle to an MIXmlNode object that represents the root of the XML document tree. It returns NULL if no root exists.

The caller has to dispose of the handle by calling the MIXmlNodeDestroy() procedure when the handle is no longer in use.