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 Note: Searching is not case sensitive.
Note Note: If IBM Virtual Member Manager (VMM) or IBM Connections is configured as a directory service provider for Content Platform Engine, this method will return only the first page of search results.
Note Note:If IBM Connections is configured as a directory service provider for Content Platform Engine, then search type options are limited to the following values: PrincipalSearchType.EXACT or PrincipalSearchType.PREFIX_MATCH.

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)

ToggleSyntax

Visual Basic (Declaration)
Function FindUsers ( _
	searchPattern As String, _
	searchType As PrincipalSearchType, _
	searchAttribute As PrincipalSearchAttribute, _
	sortType As PrincipalSearchSortType, _
	pageSize As Nullable(Of Integer), _
	filter As PropertyFilter _
) As IUserSet
C#
IUserSet FindUsers(
	string searchPattern,
	PrincipalSearchType searchType,
	PrincipalSearchAttribute searchAttribute,
	PrincipalSearchSortType sortType,
	Nullable<int> pageSize,
	PropertyFilter filter
)
Visual C++
IUserSet^ FindUsers(
	String^ searchPattern, 
	PrincipalSearchType searchType, 
	PrincipalSearchAttribute searchAttribute, 
	PrincipalSearchSortType sortType, 
	Nullable<int> pageSize, 
	PropertyFilter^ filter
)
JavaScript
function findUsers(searchPattern, searchType, searchAttribute, sortType, pageSize, filter);

Parameters

searchPattern
Type: System..::.String
A String expression that specifies the string pattern used for the search. Case does not matter.
searchType
Type: FileNet.Api.Constants..::.PrincipalSearchType
Specifies how the search pattern is applied; null indicates no preference.
searchAttribute
Type: FileNet.Api.Constants..::.PrincipalSearchAttribute
Specifies the User object property to use for the search; null indicates none.
sortType
Type: FileNet.Api.Constants..::.PrincipalSearchSortType
Specifies the desired sorting; null indicates no sorting is to be performed.
pageSize
Type: System..::.Nullable<(Of <(Int32>)>)
Specifies the size of each page of User objects returned; if null or zero (0), page size defaults to 499.
filter
Type: FileNet.Api.Property..::.PropertyFilter
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.

ToggleSee Also