Autodesk Vault ProfessionalVault API

FindCustomEntitiesBySearchConditions Method

Autodesk.Connectivity.WebServices›CustomEntityService

Returns a set of custom entities that match a given search criteria.

Required Permissions

CustomEntityRead

Syntax

public CustEnt[] FindCustomEntitiesBySearchConditions(
   SrchCond[] searchConditions,
   SrchSort[] sortConditions,
   ref System.string bookmark,
   out SrchStatus searchstatus
)
Public Function FindCustomEntitiesBySearchConditions( _
   ByVal searchConditions() As SrchCond, _
   ByVal sortConditions() As SrchSort, _
   ByRef bookmark As System.String, _
   ByRef searchstatus As SrchStatus _
) As CustEnt()

Parameters

NameDescription
searchConditionsThe search parameters.
sortConditionsThe properties to sort on. The first value in the array is the primary sort, the second value is the secondary sort, etc.
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 the objects that match the search criteria.

Remarks

There is a limit to how many results can be passed back in a single API call. If you want to get all matching objects, you may need to call this function multiple times. The searchstatus value can be used to see if more calls need to be made.

See Also