UserGroup.GetUserCollectionFromRole Method

Returns information about the collection of users assigned to the specified role definition.

Namespace:  [UserGroup Web service]
Web service reference: http://Site/_vti_bin/UserGroup.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/directory/GetUserCollectionFromRole", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/directory/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/directory/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetUserCollectionFromRole ( _
    roleName As String _
) As XmlNode
'Usage
Dim instance As UserGroup
Dim roleName As String
Dim returnValue As XmlNode

returnValue = instance.GetUserCollectionFromRole(roleName)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/directory/GetUserCollectionFromRole", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/directory/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/directory/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode GetUserCollectionFromRole(
    string roleName
)

Parameters

• roleName
  Type: System.String

  A string that contains the name of the role definition.

Return Value

Type: System.Xml.XmlNode
An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object.

<GetUserCollectionFromRole xmlns="https://schemas.microsoft.com/sharepoint/soap/directory/">
   <Users>
      <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" 
         LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" 
         Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
      <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" 
         LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" 
         Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
         .
         .
         .
   </Users>
</GetUserCollectionFromRole>

Examples

The following code example displays information about the collection of users assigned to a role definition. This example requires that a using (Visual C#) or Imports (Visual Basic) directive be included for the System.Xml namespace.

Dim usrgrpService As New Web_Reference_Folder_Name.UserGroup()
usrgrpService.Credentials = System.Net.CredentialCache.DefaultCredentials

Dim ndUsers As XmlNode = usrgrpService.GetUserCollectionFromRole("Role_Definition_Name")

MessageBox.Show(ndUsers.OuterXml)

Web_Reference_Folder_Name.UserGroup usrgrpService = new Web_Reference_Folder_Name.UserGroup();
usrgrpService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlNode ndUsers = usrgrpService.GetUserCollectionFromRole("Role_Definition_Name");

MessageBox.Show(ndUsers.OuterXml);

See Also

Reference

UserGroup Class

UserGroup Members

UserGroup Web Service