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

---

TREEMANAGER.listtrees

Retrieves a list of all the trees in the system.

Syntax

<TREEMANAGER>
   <ARGUMENT NAME="ftcmd" VALUE="listtrees"/>
   [<ARGUMENT NAME="treename" VALUE="name of tree"/>]
</TREEMANAGER>

Parameters

ftcmd (required)

Value must be set to listtrees.

treename (optional)

Name of the tree. If specified, this parameter causes tree filtering. For example, treename=Article% finds all the trees that begin with the word Article.

Description

The listtrees command retrieves a list of all the trees in the system. The list created is SystemTrees when invoked via the TREEMANAGER tag. The list field names are from the fields in the SystemInfo table.

errno

The possible values of errno include:

Value	Description
-3	No access privileges to table.
-101	No rows returned. This may be because no trees match the requested filter.

Example

<SETVAR NAME="errno" VALUE="0"/>
<TREEMANAGER>
   <ARGUMENT NAME="ftcmd" VALUE="listtrees"/>
</TREEMANAGER>

<IF COND="IsError.Variables.errno=false">
   <THEN>
      <TABLE  CELLSPACING="2" CELLPADDING="2" 
         BORDER="1" RULES="all">
         <TR>
            <TD><FONT COLOR="#000080">
               <B>Treename</B></FONT></TD>
         </TR>
         <LOOP LIST="SystemTrees">
         <TR>
            <TD>
               <CSVAR NAME="SystemTrees.tblname"/>
            </TD>
         </TR>
         </LOOP>
      </TABLE>
   </THEN>
   <ELSE>
      <BR/> No trees<BR/>
   </ELSE>
</IF>

See Also

createtree
deletetree

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