GetFolderTreeData Method

• Visual Basic
• C#

'Declaration
 
Public Shared Function GetFolderTreeData( _
   ByVal folderTreeLevel As Folders.FolderTreeLevel, _
   ByVal itemClassID As String, _
   ByVal itemClassDesc As String, _
   ByVal itemID As String, _
   ByVal itemDesc As String, _
   ByVal operID As String, _
   ByVal operDesc As String, _
   ByVal entID As String, _
   ByVal verID As String, _
   ByVal udf1 As String, _
   ByVal udf2 As String, _
   ByVal file As String, _
   ByVal restrictToEnt As String _
) As DataSet

public static DataSet GetFolderTreeData( 
   Folders.FolderTreeLevel folderTreeLevel,
   string itemClassID,
   string itemClassDesc,
   string itemID,
   string itemDesc,
   string operID,
   string operDesc,
   string entID,
   string verID,
   string udf1,
   string udf2,
   string file,
   string restrictToEnt
)

Parameters

folderTreeLevel

Required. Holds the level of the tree being opened. Data is to be filled for all the nodes contained within the node being opened.

itemClassID

Optional. Holds the item class ID by which to filter the data being retrieved. This is optional for the Initialize level, but must be supplied for all other levels.

itemClassDesc

Optional. Holds the the item class description by which to filter the data being retrieved.

itemID

Holds the item ID by which to filter the data being retrieved. This is optional for the Initialize and ItemClass levels, but must be supplied for all other levels.

itemDesc

Optional. Holds the item description by which to filter the data being retrieved.

operID

Optional. Holds the operation ID by which to filter the data being retrieved. This is optional for the Initialize, ItemClass, and Item levels, but must be supplied for all other levels.

operDesc

Optional. Holds the operation description by which to filter the data being retrieved. This is optional for the Initialize, ItemClass, and Item levels, but must be supplied for all other levels.

entID

Optional. Holds the entity ID by which to filter the data being retrieved.

verID

Optional. Holds the version ID by which to filter the data being retrieved.

udf1

Optional. Holds the first user-defined field by which to filter the data being retrieved.

udf2

Optional. Holds the second user-defined field by which to filter the data being retrieved.

file

Optional. Holds the file by which to filter the data being retrieved.

restrictToEnt

Optional. Holds a flag that, if set to true, specifies that only the specified entity's folders should be shown. If set to false, the folders for the entity and all its ancestors should be shown. This parameter only has meaning if the entID parameter is also set.

Return Value