FindFileFoldersBySearchConditions Method
Performs a search on the Vault for a list of FileFolders.
Required Permissions
FileReadSyntax
public FileFolder[] FindFileFoldersBySearchConditions(
SrchCond[] conditions,
SrchSort[] sortConditions,
System.long[] folderIds,
System.bool recurseFolders,
System.bool latestOnly,
ref System.string bookmark,
out SrchStatus searchstatus
)Public Function FindFileFoldersBySearchConditions( _
ByVal conditions() As SrchCond, _
ByVal sortConditions() As SrchSort, _
ByVal folderIds() As System.Long, _
ByVal recurseFolders As System.Boolean, _
ByVal latestOnly As System.Boolean, _
ByRef bookmark As System.String, _
ByRef searchstatus As SrchStatus _
) As FileFolder()Parameters
| Name | Description |
|---|---|
| conditions | The search parameters. Entering an array of length 0 is legal, but a null array is illegal. |
| sortConditions | The properties to sort on. The first value in the array is the primary sort, the second value is the secondary sort, etc. |
| folderIds | A list of folders to search in. |
| recurseFolders | If false, only files in the specified folders will be searched. If true the specified folders and their sub-folders will be searched. |
| latestOnly | If true, than only the latest version of a file folder will be returned. Otherwise all matching versions will be returned. |
| bookmark | [in/out] Used to continue a search if the results are too large for a single call. Pass in null 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 file folders or null if there are no matches.