GetDescription

Description

Returns a string describing the contents of the database.

The description string is initially set when the database is created in ClearQuest® Designer. To modify this string programmatically, you must modify the Description property of the Database object.

Syntax

VBScript

dbDesc.GetDescription 

Perl

$dbDesc->GetDescription(); 

Identifier

Description

dbDesc

A DatabaseDesc object containing information about one of the installed databases.

Return value

A String containing descriptive comments about the database.

Examples

VBScript

The following example shows you how to log on to the database from a Visual Basic application.

set sessionObj = CreateObject("CLEARQUEST.SESSION") 
' Login to each database successively. 
databases = sessionObj.GetAccessibleDatabases("MASTR","","")
For Each db in databases 
   dbDescription = db.GetDescription 
   ' ... 
Next 

Perl

use CQPerlExt;

#Start the ClearQuest session
$sessionObj = CQSession::Build();

#Get a list of accessible database description objects

$databases = $sessionObj->GetAccessibleDatabases("MASTR", "", "");

#Get the number of databases

$count = $databases->Count();

#For each accessible database, get the description

#of the contents of the database   

for($x=0;$x<$count;$x++){

   $db = $databases->Item($x);

   $dbDescription = $db->GetDescription();

#...

}

CQSession::Unbuild($sessionObj);