Utility.SearchPrincipals - Méthode

Article
05/05/2016

Retourne la collection de principaux qui aurait ou partiellement correspondent aux critères de recherche spécifiés.

Espace de noms : Microsoft.SharePoint.Client.Utilities
Assemblys : Microsoft.SharePoint.Client.Silverlight (dans Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client.Phone (dans Microsoft.SharePoint.Client.Phone.dll) Microsoft.SharePoint.Client (dans Microsoft.SharePoint.Client.dll)

Syntaxe

'Déclaration
Public Shared Function SearchPrincipals ( _
    context As ClientRuntimeContext, _
    web As Web, _
    input As String, _
    scopes As PrincipalType, _
    sources As PrincipalSource, _
    usersContainer As UserCollection, _
    maxCount As Integer _
) As IList(Of PrincipalInfo)
'Utilisation
Dim context As ClientRuntimeContext
Dim web As Web
Dim input As String
Dim scopes As PrincipalType
Dim sources As PrincipalSource
Dim usersContainer As UserCollection
Dim maxCount As Integer
Dim returnValue As IList(Of PrincipalInfo)

returnValue = Utility.SearchPrincipals(context, _
    web, input, scopes, sources, usersContainer, _
    maxCount)

public static IList<PrincipalInfo> SearchPrincipals(
    ClientRuntimeContext context,
    Web web,
    string input,
    PrincipalType scopes,
    PrincipalSource sources,
    UserCollection usersContainer,
    int maxCount
)

Paramètres

context
Type : Microsoft.SharePoint.Client.ClientRuntimeContext

web
Type : Microsoft.SharePoint.Client.Web

Spécifie le site à utiliser lors de la recherche pour une identité.

NULLne doit pas être.

input
Type : System.String

Spécifie la valeur à utiliser lors de la recherche pour une identité.

Si ce n'est pas le nom complet, une adresse de messagerie ou un nom de connexion d'un investissement, le serveur doit renvoyer NULL.

NULLne doit pas être. Sa longueur doit être inférieure ou égale à 255 à.

scopes
Type : Microsoft.SharePoint.Client.Utilities.PrincipalType

Spécifie le type à utiliser lors de la recherche pour une identité.

sources
Type : Microsoft.SharePoint.Client.Utilities.PrincipalSource

Spécifie la source à utiliser lors de la recherche pour une identité.

usersContainer
Type : Microsoft.SharePoint.Client.UserCollection

Spécifie la collection d'utilisateurs à utiliser lors de la recherche pour une identité.

maxCount
Type : System.Int32

Spécifie le nombre maximal de principaux à retourner dans la liste.

Si la valeur est égale ou inférieure à 0, le serveur doit renvoyer une collection vide.

Valeur renvoyée

Type : System.Collections.Generic.IList<PrincipalInfo>
Renvoie une instance IList<T> représentant la collection de principaux qui aurait ou partiellement correspondent aux critères de recherche spécifiés.

Exceptions

Exception	Condition
[System.UnauthorizedAccessException]	L'utilisateur actuel dispose des autorisations suffisantes. Code d'erreur : -2147024891.

Voir aussi

Référence

Utility classe

Utility - Membres

Microsoft.SharePoint.Client.Utilities - Espace de noms

Partager via