GetGroup

Description

Returns the group object with the specified name.

The groupName parameter corresponds to the value in the Name of the Group object.

Syntax

VBScript

adminSession.GetGroup (groupName) 

Perl

$adminSession->GetGroup(groupName); 

Identifier

Description

adminSession

The AdminSession object representing the current schema repository access session.

groupName

A String containing the name of the database object you want.

Return value

The Group Object with the specified name, or null if no such group exists.

Example

VBScript

set adminSession = CreateObject("ClearQuest.AdminSession")
adminSession.Logon "admin", "admin", ""

set groupObj = adminSession.GetGroup ("Engineers") 

Perl

use CQPerlExt;

#Create a HCL Compass admin session
$adminSession= CQAdminSession::Build();

#Logon as admin
$adminSession->Logon( "admin", "admin", "" );

#Get the group "Engineers" object
$groupObj = $adminSession->GetGroup( "Engineers" );

#...

CQAdminSession::Unbuild($adminSession);