Returns a set of groups from this realm that matches the search parameters.
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 FindGroups( _ 
   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 IGroupSet
C#
IGroupSet FindGroups(
   string searchPattern,
   PrincipalSearchType searchType,
   PrincipalSearchAttribute searchAttribute,
   PrincipalSearchSortType sortType,
   Nullable<int> pageSize,
   PropertyFilter filter
)
C++
IGroupSet FindGroups(
   String searchPattern,
   PrincipalSearchType searchType,
   PrincipalSearchAttribute searchAttribute,
   PrincipalSearchSortType sortType,
   Nullable<int> pageSize,
   PropertyFilter filter
) abstract 
J#
IGroupSet FindGroups(
   string searchPattern,
   PrincipalSearchType searchType,
   PrincipalSearchAttribute searchAttribute,
   PrincipalSearchSortType sortType,
   Nullable<int> pageSize,
   PropertyFilter filter
)
JScript
function FindGroups(
   searchPattern : String,
   searchType : PrincipalSearchType,
   searchAttribute : PrincipalSearchAttribute,
   sortType : PrincipalSearchSortType,
   pageSize : Nullable<int>,
   filter : PropertyFilter
) : IGroupSet

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 Group 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 Group 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 GroupSet object containing the Group objects matching the search request.

See Also