Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

SITEPLAN.ROOT

Queries the SitePlanTree table for a root node of the site plan.

Syntax

<SITEPLAN.ROOT 
      LIST="rootNode"
      [OBJECTID="site ID"]/> 

Parameters

LIST (required)

Name to assign to the list that stores the root node. The columns of the list match those from the SitePlanTree table. If a list with this name already exists, it is replaced with this new list.

OBJECTID (optional)

Site (formerly publication) ID.

Description

You use this tag to extract and display information about the site structure from the top down.

If you use the OBJECTTYPE parameter, the result is a join of the SitePlanTree and the Publication table (only a site can be a root). The name and description fields in the Publication table are then accessible without requiring a subsequent SITEPLAN.LOAD for the site plan.

errno

The possible values of errno include:

Value	Description
-10001	The implementing class is invalid.
-10002	There is a missing method for the implementing class.
-10003	The method could not be invoked successfully.
-10004	A required parameter is missing.
-10006	The object ID is not valid.
-10007	The version of the object is not valid.
-10008	The node ID of the object is not valid.

Example

This code retrieves the root node identified by the object ID and stores it in a list named "PubRoot":

<SITEPLAN.ROOT LIST="PubRoot" OBJECTID="968251170475"/> 

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.