UserGroup.GetGroupInfo Method

Returns information about the specified group.

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

Syntax

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

returnValue = instance.GetGroupInfo(groupName)

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

Parameters

• groupName
  Type: System.String

  A string that contains the name of the group.

Return Value

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

<GetGroupInfo xmlns=
   "https://schemas.microsoft.com/sharepoint/soap/directory/">
   <Group ID="3" Name="Group1" Description="Description" OwnerID="1" 
      OwnerIsUser="False" />
</GetGroupInfo>

Examples

The following code example displays information about a specified group. 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 ndGroup As System.Xml.XmlNode = usrgrpService.GetGroupInfo("Group_Name")

MessageBox.Show(ndGroup.OuterXml)

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

System.Xml.XmlNode ndGroup = usrgrpService.GetGroupInfo("Group_Name");

MessageBox.Show(ndGroup.OuterXml);

See Also

Reference

UserGroup Class

UserGroup Members

UserGroup Web Service