LoadKmlLayer

This method loads a KML file into the current project. All the objects from the KML file, including locations, presentations, and hyperlinks, are added.

 

JavaScript

 

LoadKmlLayer(

       KmlURL,

       ParentGroupID)

 

C#

 

string LoadKmlLayer(

       string KmlURL,

       string ParentGroupID = "")

 

C++

 

HRESULT LoadKmlLayer(

       BSTR KmlURL,

       BSTR ParentGroupID,

       BSTR * GroupID) 

Parameters

KmlURL 

A full path name or a URL to the KML file to load.

ParentGroupID

The Project Tree group in which to put the objects from the imported KML file. If set to zero, the object is created under the root. The layer objects are put in a group with the name of the KML file (e.g., for the file “C:\MyKML.kml”, a new group named “MyKML” is created), and maintain the same internal group hierarchy as the loaded file. You can obtain the GroupID by one of the following methods:

·          Create the group using IProjectTree80.CreateGroup.

·          Find the group, if you know the name, using IProjectTree80.FindItem.

·          Traverse the Tree using IProjectTree80 methods such as GetNextItem.

Return Value

GroupID

The ID of the newly created group which contains the KML object.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP

The group ID entered does not represent a valid group in the Project Tree.

TE_E_INFOTREE_ITEMNOTGROUP

The item entered is not a group and therefore cannot be used as a group.

TE_E_INFOTREE_CANTUSEROOT

Cannot use Tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

Item ID is a group so an object cannot be retrieved.