Autodesk Vault ProfessionalVault API

FindFoldersBySearchConditions Method

Autodesk.Connectivity.WebServicesDocumentService

Performs a Folder search.

Required Permissions

FolderRead

Syntax

public Folder[] FindFoldersBySearchConditions(
   SrchCond[] conditions,
   SrchSort[] sortConditions,
   System.long[] folderIds,
   System.bool recurseFolders,
   ref System.string bookmark,
   out SrchStatus searchstatus
)
Public Function FindFoldersBySearchConditions( _
   ByVal conditions() As SrchCond, _
   ByVal sortConditions() As SrchSort, _
   ByVal folderIds() As System.Long, _
   ByVal recurseFolders As System.Boolean, _
   ByRef bookmark As System.String, _
   ByRef searchstatus As SrchStatus _
) As Folder()

Parameters

NameDescription
conditionsThe search parameters. Entering an array of length 0 is legal, but a null array is illegal.
sortConditionsThe properties to sort on. The first value in the array is the primary sort, the second value is the secondary sort, etc.
folderIdsA list of folders to search in.
recurseFoldersIf false, only files in the specified folders will be searched. If true the specified folders and their sub-folders will be searched.
bookmark[in/out] Used to continue a search if the results are too large for a single call. Pass in an empty string for the first call of the search. Pass in the returned bookmark string for subsequent calls on that search.
searchstatus[out] Returns status information about the search.

Return Value

A list of all matching Folders or null if there are no matches.

See Also