Autodesk Vault ProfessionalVault API

FindInFileSetBySearchConditions Method

Autodesk.Connectivity.WebServicesDocumentService

Performs a search within a group of files.

Required Permissions

FileRead

Syntax

public File[] FindInFileSetBySearchConditions(
   SrchCond[] conditions,
   SrchSort[] sortConditions,
   System.long[] fileIds,
   ref System.string bookmark,
   out SrchStatus searchStatus
)
Public Function FindInFileSetBySearchConditions( _
   ByVal conditions() As SrchCond, _
   ByVal sortConditions() As SrchSort, _
   ByVal fileIds() As System.Long, _
   ByRef bookmark As System.String, _
   ByRef searchStatus As SrchStatus _
) As File()

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.
fileIdsAn array of file ID values to act as the file set.
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 files or null if there are no matches.

See Also