Programming Mechworks PDM > DBWCommandShell > Commands Reference > Tree

Description

Writes the actual tree structure built in the Tree Page on the assigned file.

The difference with the analogous command WriteTree is that the WriteTree writes a tree without the top-level-items-only optimization and it does not need the browser to be opened and the Tree Page to be displayed.

Syntax

call DBWShell("WriteActualTree FileName [okWritePhysicalQuantities [firstLevelOnly]]")

Parameters

FileName	filename to write tree into. Please note any space char in filenames and paths must be replaced by "\|" char.
okWritePhysicalQuantities	Optional. 0: doesn't write physical quantities 1: writes the physical quantities in the tree
firstLevelOnly	Optional. 0: include every level 1: limits the Tree output to the 1st level only

FileName

filename to write tree into.

Please note any space char in filenames and paths must be replaced by "|" char.

okWritePhysicalQuantities

Optional.
0: doesn't write physical quantities
1: writes the physical quantities in the tree

firstLevelOnly

Optional.
0: include every level
1: limits the Tree output to the 1st level only

Remarks

The browser must be open and the Tree Page must be active.

This command is not intended for trees containing sub-projects. If you apply this command to a sub-project tree, you'll obtain only first level children and not the whole tree as for other type of documents.

To walk through sub-project trees use commands such as DBWWalkTree, DBWWalkTreeAllInstances, DBWWalkTreeBottomTop

Example

Sub Main()

DBWInit(True)
DBWShell("WriteActualTree F:\temp\test.txt")
End sub