GetDescription

Description

Returns a string describing the contents of the database.

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

Syntax

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.

Example

Perl

use CQPerlExt;

#Start the DevOps
Plan 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);