3.2.5.136.2.1.16 SearchPrincipalsUsingContextWeb

  • Article

This method is a static CSOM method.

Return Type: CSOM array of Microsoft.SharePoint.Client.Utilities.PrincipalInfo

Returns the collection of principals that partially or uniquely matches the specified search criteria in the context of the current Web site.<118>

Parameters:

input: Specifies the value to be used when searching for a principal.

Type: CSOM String

If this is not the display name, e-mail address, or login name of a principal, the server MUST return an empty collection.

It MUST NOT be NULL. Its length MUST be equal to or less than 255.

scopes: Specifies the type to be used when searching for a principal.

Type: Microsoft.SharePoint.Client.Utilities.PrincipalType

sources: Specifies the source to be used when searching for a principal.

Type: Microsoft.SharePoint.Client.Utilities.PrincipalSource

groupName: Specifies the name of a site collection group in the site collection that contains the current Web site. The collection of users in this site collection group is used when searching for a principal.

Type: CSOM String

maxCount: Specifies the maximum number of principals to be returned.

Type: CSOM Int32

If the value is equal to or less than 0, the server MUST return an empty collection.