UserGroup.GetGroupCollectionFromUser Method

Returns information about the collection of groups of which the specified user is a member.

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

Syntax

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

returnValue = instance.GetGroupCollectionFromUser(userLoginName)

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

Parameters

• userLoginName
  Type: System.String

  A string that contains the user name (DOMAIN\User_Alias) of the user.

Return Value

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

<GetGroupCollectionFromUser xmlns=
   "https://schemas.microsoft.com/sharepoint/soap/directory/">
   <Groups>
      <Group ID="3" Name="Group1" Description="Description" OwnerID="1" 
         OwnerIsUser="False" />
      <Group ID="15" Name="Group2" Description="Description" 
         OwnerID="12" OwnerIsUser="True" />
      <Group ID="16" Name="Group3" Description="Description" 
         OwnerID="7" OwnerIsUser="False" />
   </Groups>
</GetGroupCollectionFromUser>

Examples

The following code example displays information about the groups of which a specified user is a member. 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 ndGroups As System.Xml.XmlNode = usrgrpService.GetGroupCollectionFromUser("DOMAIN\User_Alias")

MessageBox.Show(ndGroups.OuterXml)

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

System.Xml.XmlNode ndGroups = usrgrpService.GetGroupCollectionFromUser("DOMAIN\\User_Alias");

MessageBox.Show(ndGroups.OuterXml);

See Also

Reference

UserGroup Class

UserGroup Members

UserGroup Web Service