Groupwise Developer's Guide

38
Although this method can quickly run through an entire Folders collection, it
leaves much to be desired, if you wish to find a particular folder, in part because
you (and your code) may not know how the end user has ordered the folders in his
or her account. If Index is a string, it represents a FolderID in which case
Folders.Item(Index) will return the folder within the collection that has a
matching FolderID. If the FolderID is invalid or refers to a folder that is not within
the particular Folders collection, then the method will throw an exception. This
too, leaves much to be desired, as a particular FolderID may be unknown. The
following method accepts a folder name.
Folders.ItemByName(Name as String)
This is a tricky method; it will return the first instance of any given folder that
matches Folder.Name. If, for example, you have several sub-folders with the same
name but different parent folders, you should always check the Name property of
Folder.ParentFolder to determine exactly which folder you have obtained.
There is no way to make successive ItemByName() calls; thus, you may need
to use the Item() method and iterate through all of the folders in order to find
the folder you are looking for. Because ItemByName() may be called by any
given Folders object, you can limit the folders in which you search. For
example, you might search in the Cabinet, or you might iterate through each
top-level folder in the cabinet using the Item() method and then call
ItemByName() within each top-level folder’s collection. The following is an
example procedure that searches each top-level folder for the first folder named
‘MainFolder’ in each folder within the Cabinet (but it does not find folders in the
Cabinet that happen to be called ‘MainFolder’):
Example in VB:
'gwAccount is a valid Account object
Dim gwFolders As GroupwareTypeLibrary.Folders
Dim gwFolder As GroupwareTypeLibrary.Folder2
Dim gwCurrentFolder As GroupwareTypeLibrary.Folder2
Private Sub FindFoldersByName()
'Get the most recent Folders list.
gwAccount.Refresh
Set gwFolders = gwAccount.Cabinet.Folders
If gwFolders.Count > 0 Then
For i = 1 To gwFolders.Count
Set gwCurrentFolder = gwFolders.Item(i)
On Error GoTo FldrErr
Set gwFolder = gwCurrentFolder.Folders.ItemByName("MainFolder")
Next i
End If
www.novell.com/appnotes