FindLinksBySearchConditions Method
Gets the links on an entity that matches a set of search criteria.
Required Permissions
LinkReadSyntax
public Lnk[] FindLinksBySearchConditions(
SrchCond[] conditions,
SrchSort[] sortConditions,
System.string[] parentEntityClassIds,
System.long[] parentIds,
System.bool recurseFolders,
System.string[] targetEntityClassIds,
ref System.string bookmark,
out SrchStatus searchstatus
)Public Function FindLinksBySearchConditions( _
ByVal conditions() As SrchCond, _
ByVal sortConditions() As SrchSort, _
ByVal parentEntityClassIds() As System.String, _
ByVal parentIds() As System.Long, _
ByVal recurseFolders As System.Boolean, _
ByVal targetEntityClassIds() As System.String, _
ByRef bookmark As System.String, _
ByRef searchstatus As SrchStatus _
) As Lnk()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. |
| parentEntityClassIds | The entity classes for the parent entity. A null value will search through all entity classes. |
| parentIds | The parent entities to search in. A null value will search through all links regardless of the parents. |
| recurseFolders | If false, only files in the specified folders will be searched. If true the specified folders and their sub-folders will be searched. |
| targetEntityClassIds | The entity classes for the target entity. A null value will search through all entity classes. |
| 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 Links pointing to an Entity that matches the search criteria.
Remarks
Links don't have properties of their own. So the search is on the Entity, but the Link is what is returned. If an Entity has no Links, then it will not return anything from the search even it it matches the search criteria. Likewise if an Enity has multiple links, they will all be returned if it matches the search criteria.