Get Group

API Type

Web Services

Description

Retrieves a group object with the specified group name.

Syntax

public virtual WFGroup GetGroup(string groupName)

Parameters

Name	Description
groupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.

Output

WFGroup object. If the specified group does not exist, the output is null.

Example

IWFAdminService svc = GetAdminService();
string groupName = ...// for example, "Administrators";

try
	{
    WFGroup grpInfo = svc.GetGroup(groupName);
    Console.WriteLine("Group Name:{0}; Group Lead:{1}", grpInfo.Name,
    grpInfo.ResponsibleUser);                   
	}

catch (Exception ex)
	{
	Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}
/*
This example produces the following results:
Group Name:Administrators; Group Lead:\Administrator
*/

Supported Versions

3.2.0.4 and higher