People.SearchPrincipals - Méthode

Article
05/11/2015

Retourne un tableau d'objets PrincipalInfo de la SPUserCollection pour le site Web. Toutes les instances ont le nom de l'entité de sécurité d'ouverture de session spécifié dans searchText. Seuls les objets maxResults peuvent être ajoutés dans le tableau.

Espace de noms : WebSvcPeople
Assembly : STSSOAP (dans STSSOAP.dll)

Syntaxe

'Déclaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/SearchPrincipals", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function SearchPrincipals ( _
    searchText As String, _
    maxResults As Integer, _
    principalType As SPPrincipalType _
) As PrincipalInfo()
'Utilisation
Dim instance As People
Dim searchText As String
Dim maxResults As Integer
Dim principalType As SPPrincipalType
Dim returnValue As PrincipalInfo()

returnValue = instance.SearchPrincipals(searchText, _
    maxResults, principalType)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/SearchPrincipals", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public PrincipalInfo[] SearchPrincipals(
    string searchText,
    int maxResults,
    SPPrincipalType principalType
)

Paramètres

searchText
Type : System.String

Nom de l'entité de sécurité d'ouverture de session.

maxResults
Type : System.Int32

Sauf indication contraire, le nombre maximal d'entités de sécurité qui peut être retourné à partir d'un fournisseur est 10.

principalType
Type : WebSvcPeople.SPPrincipalType

objet SPPrincipalType qui spécifie la portée de l'utilisateur et d'autres informations.

Valeur renvoyée

Type : []
Une liste d'objets PrincipalInfo qui est indexé et accessible par son nom d'ouverture de session principale.

Remarques

Un utilisateur peut avoir plus d'un type d'accès d'autorisation au sein d'un site Web. Un utilisateur peut faire partie d'un groupe de SharePoint Foundation et une liste de distribution, en plus d'avoir accès à un site Web qui est autorisé par leur nom d'ouverture de session. Par conséquent, il peut exister plusieurs copies du même utilisateur identificateur (ID) qui est associé à un site Web spécifique.

Un sous-ensemble d'informations de l'utilisateur est compilé à partir de sources de fournisseur et les étendues de sécurité qui sont associés à un site Web. Ce sous-ensemble de la SPUserCollection pour le site Web de recherche est effectuée pour toutes les occurrences qui contiennent le nom d'ouverture de session spécifié dans le paramètre searchText et qui sont du type principal spécifié. Si le nom d'ouverture de session et la paire principal se trouve dans le sous-ensemble, les champs appropriés de la ligne sont copiés à partir du sous-ensemble dans le tableau qui est retourné à l'appelant du module. Si la paire de type principal et de nom de connexion n'existe pas dans le sous-ensemble de la SPUserCollection, Impossible de l'ajouter au tableau.

Uniquement les lignes maxResults peuvent être renvoyées vers le module appelant.