GetGroupCollection Method

  • Article

The GetGroupCollection method of the Users and Groups service returns information about the specified cross-site groups in the current site collection.

Parameters

groupNamesXml   A System.Xml.XmlNode object that specifies one or more cross-site group names in the following form:

<Groups>
   <Group GroupName="Group1"/>
   <Group GroupName="Group2"/>
   .
   .
   .
</Groups>

Return Value

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

<GetGroupCollection xmlns="http://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" />
      .
      .
      .
   </Groups>
</GetGroupCollection>

Example

The following code example displays information about specified cross-site groups on a site. The example assumes the existence of a local XML file that contains the names of the groups, which are loaded into a System.Xml.XmlDocument object.

This example requires that a using (C#) or Imports (Visual Basic .NET) directive be included for the System.Xml namespace.

Requirements

Platforms: Microsoft Windows Server 2003

Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/UserGroup.asmx