Returns a set of users, a page at a time, from this realm that matches the search parameters. The size of each page of results is governed by the value of the
Namespace: FileNet.Api.Security
Assembly: FileNet.Api (in filenet.api.dll)
pageSize
parameter. ![]() |
---|
Searching is not case sensitive. |
The rules that govern the search behavior are:
- If
has a non-null value (not none), thensortType
must also have a non-null value. (searchAttribute
needs a value to sort on.)sortType - If either
orsearchPattern
has a positive value (not empty or non-null, respectively), thensearchType
,searchPattern
, andsearchType
must all have positive values.searchAttribute
Namespace: FileNet.Api.Security
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Function FindUsers( _ ByVal searchPattern As String, _ ByVal searchType As PrincipalSearchType, _ ByVal searchAttribute As PrincipalSearchAttribute, _ ByVal sortType As PrincipalSearchSortType, _ ByVal pageSize As Nullable(Of Integer), _ ByVal filter As PropertyFilter _ ) As IUserSet |
C# |
---|
IUserSet FindUsers( string searchPattern, PrincipalSearchType searchType, PrincipalSearchAttribute searchAttribute, PrincipalSearchSortType sortType, Nullable<int> pageSize, PropertyFilter filter ) |
C++ |
---|
IUserSet FindUsers( String searchPattern, PrincipalSearchType searchType, PrincipalSearchAttribute searchAttribute, PrincipalSearchSortType sortType, Nullable<int> pageSize, PropertyFilter filter ) abstract |
J# |
---|
IUserSet FindUsers( string searchPattern, PrincipalSearchType searchType, PrincipalSearchAttribute searchAttribute, PrincipalSearchSortType sortType, Nullable<int> pageSize, PropertyFilter filter ) |
JScript |
---|
function FindUsers( searchPattern : String, searchType : PrincipalSearchType, searchAttribute : PrincipalSearchAttribute, sortType : PrincipalSearchSortType, pageSize : Nullable<int>, filter : PropertyFilter ) : IUserSet |
Parameters
- searchPattern
- A
expression that specifies the string pattern used for the search. Case does not matter.String
- searchType
- Specifies how the search pattern is applied;
indicates no preference.null
- searchAttribute
- Specifies the
object property to use for the search;User
indicates none.null
- sortType
- Specifies the desired sorting;
indicates no sorting is to be performed.null
- pageSize
- Specifies the size of each page of
objects returned; ifUser
or zero (0), page size defaults to 499.null
- filter
- A
object that represents information for controlling which property values (and with what level of detail and recursion) to return. IfPropertyFilter
, this method returns values for all non-object properties and returns placeholders for all object-valued properties (null
properties with a state ofPropertyEngineObject
orPropertyState.UNEVALUATED
); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.PropertyState.REFERENCE
Return Value
A
object containing the
objects matching the search request.