uaPLUS Reference
GetEnum Method
See Also  Send Feedback
I_HDAPluginDBA Namespace > IBrowserDBA Interface : GetEnum Method

brwType
The type of browse to perform.
count
The number of enumerated nodes.
nodes
The enumerated branch/item nodes.

Glossary Item Box

Enumerate the nodes at the current branch. This method returns a string array with a list of leaves, branches, or ItemIDs, depending on the browse type requested. Whether a branch is an ItemID is undetermined and may be server dependent. The members of the enum set will be determined by the position of the browser in the server address space and the value of the filters when the browser interface was created. If no ItemIDs pass the filter criteria, the enum set is empty. Thus, a server which has a flat namespace would always return an empty array when asked for a list of branches, and it would return the same list whether it was asked for leafs or ItemIDs, since all of its Items are, by definition, leafs.

Syntax

Visual Basic (Declaration) 
Function GetEnum( _
   ByVal brwType As BrowseType, _
   ByRef count As Integer, _
   ByRef nodes As String() _
) As Integer
C# 
int GetEnum( 
   BrowseType brwType,
   out int count,
   out string[] nodes
)

Parameters

brwType
The type of browse to perform.
count
The number of enumerated nodes.
nodes
The enumerated branch/item nodes.

Return Value

Success/failure HRESULT

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.