Autodesk Vault ProfessionalVault API

FindFileElementsBySearchClause Method

Autodesk.Connectivity.WebServicesDocumentServiceExtensions

Gets a set of file elements and their properties for a given set of search conditions.

Syntax

public FileElement[] FindFileElementsBySearchClause(
   FileElementSrchClause searchClause,
   ref System.int bookmark,
   SrchCond[] fileSearchConditions,
   System.long[] fileIds,
   System.long[] folderIds,
   out System.int totalHits
)
Public Function FindFileElementsBySearchClause( _
   ByVal searchClause As FileElementSrchClause, _
   ByRef bookmark As System.Integer, _
   ByVal fileSearchConditions() As SrchCond, _
   ByVal fileIds() As System.Long, _
   ByVal folderIds() As System.Long, _
   ByRef totalHits As System.Integer _
) As FileElement()

Parameters

NameDescription
searchClauseThe search conditions for the file element properties.
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.
fileSearchConditionsThe search conditions for the file properties.
fileIdsThe set of files to search. Pass in null to search all files. If this value is non-null, then 'folderIds' must be null.
folderIdsThe set of folders to search (non recursive). Pass in null to search all folders. If this value is non-null, then 'fileIds' must be null.
totalHits[out] The total number of hits for the search.

Return Value

Returns the matching elements along with all the related element property values.

See Also