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 pageSize parameter.
Note
Searching is not case sensitive.

The rules that govern the search behavior are:

  • If sortType has a non-null value (not none), then searchAttribute must also have a non-null value. (sortType needs a value to sort on.)
  • If either searchPattern or searchType has a positive value (not empty or non-null, respectively), then searchPattern, searchType, and searchAttribute must all have positive values.

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 String expression that specifies the string pattern used for the search. Case does not matter.
searchType
Specifies how the search pattern is applied; null indicates no preference.
searchAttribute
Specifies the User object property to use for the search; null indicates none.
sortType
Specifies the desired sorting; null indicates no sorting is to be performed.
pageSize
Specifies the size of each page of User objects returned; if null or zero (0), page size defaults to 499.
filter
A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.

Return Value

A UserSet object containing the User objects matching the search request.

See Also