SPUtility.GetPrincipalsInGroup Method

Gets users or groups that belong to the specified group. The specified group can be a Microsoft Windows security group, an ASP.NET role, or a SharePoint group.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)> _
<DirectoryServicesPermissionAttribute(SecurityAction.Assert, Unrestricted := True)> _
Public Shared Function GetPrincipalsInGroup ( _
    web As SPWeb, _
    input As String, _
    maxCount As Integer, _
    <OutAttribute> ByRef reachedMaxCount As Boolean _
) As SPPrincipalInfo()
'Usage
Dim web As SPWeb
Dim input As String
Dim maxCount As Integer
Dim reachedMaxCount As Boolean
Dim returnValue As SPPrincipalInfo()

returnValue = SPUtility.GetPrincipalsInGroup(web, _
    input, maxCount, reachedMaxCount)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)]
[DirectoryServicesPermissionAttribute(SecurityAction.Assert, Unrestricted = true)]
public static SPPrincipalInfo[] GetPrincipalsInGroup(
    SPWeb web,
    string input,
    int maxCount,
    out bool reachedMaxCount
)

Parameters

• web
  Type: Microsoft.SharePoint.SPWeb

  The Web site for which the current user has the BrowseUserInfo permission.

• input
  Type: System.String

  The group to query for.

• maxCount
  Type: System.Int32

  The maximum number of members to return.

• reachedMaxCount
  Type: System.Boolean

  The information about whether the maximum number of members has been reached.

Return Value

Type: []
true if there are more members that were not returned; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	The web or input parameter is a null reference (Nothing in Visual Basic).
ArgumentException	The maxCount parameter is less than 0.

See Also

Reference

SPUtility Class

SPUtility Members

Microsoft.SharePoint.Utilities Namespace