SPUtility.SearchPrincipals Method (SPWeb, String, SPPrincipalType, SPPrincipalSource, SPUserCollection, Int32, Boolean)
Namespace: Microsoft.SharePoint.Utilities
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.InterfaceType)> _
Public Shared Function SearchPrincipals ( _
web As SPWeb, _
input As String, _
scopes As SPPrincipalType, _
sources As SPPrincipalSource, _
usersContainer As SPUserCollection, _
maxCount As Integer, _
<OutAttribute> ByRef reachMaxCount As Boolean _
) As IList(Of SPPrincipalInfo)
'Usage
Dim web As SPWeb
Dim input As String
Dim scopes As SPPrincipalType
Dim sources As SPPrincipalSource
Dim usersContainer As SPUserCollection
Dim maxCount As Integer
Dim reachMaxCount As Boolean
Dim returnValue As IList(Of SPPrincipalInfo)
returnValue = SPUtility.SearchPrincipals(web, _
input, scopes, sources, usersContainer, _
maxCount, reachMaxCount)
[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.InterfaceType)]
public static IList<SPPrincipalInfo> SearchPrincipals(
SPWeb web,
string input,
SPPrincipalType scopes,
SPPrincipalSource sources,
SPUserCollection usersContainer,
int maxCount,
out bool reachMaxCount
)
Parameters
- web
Type: Microsoft.SharePoint.SPWeb
- input
Type: System.String
- scopes
Type: Microsoft.SharePoint.Utilities.SPPrincipalType
- sources
Type: Microsoft.SharePoint.Utilities.SPPrincipalSource
- usersContainer
Type: Microsoft.SharePoint.SPUserCollection
- maxCount
Type: System.Int32
- reachMaxCount
Type: System.Boolean
Return Value
Type: System.Collections.Generic.IList<SPPrincipalInfo>
Returns IList<T>.