GetChartList

Description

Returns the specified list of charts.

Note: This method is for Windows™ only.

You must first call SetSession on the Workspace object, if you have not created a Session object.

Returns the pathnames of the public or personal charts defined in the HCL Compass workspace. The typeOfCharts parameter lets you specify the type of charts to return. Specifying the constant OLEWKSPCSYSTEMQUERIES (1 for Perl) returns only the public charts defined by the HCL Compass administrator. Specifying the constant OLEWKSPCBOTHQUERIES (3 for Perl) returns a list of all of the charts in the workspace (including those of all users).

To return only the charts defined by a particular user, first set the current user name by calling the SetUserName method, then, call this method, specifying the constant OLEWKSPCUSERQUERIES (2 for Perl) for the typeOfCharts parameter.

Syntax

VBScript


workspace.GetChartList typeOfCharts

Perl


$workspace->GetChartList(typeOfCharts);
Identifier
Description
workspace
The Workspace object obtained from the current session.
typeOfCharts
The type of charts to return.
  1. public charts
  2. personal charts
  3. all public and personal charts

For Visual Basic, this value corresponds to one of the WorkspaceQueryType constants enumerated constants.

Return value
In Visual Basic, an array of Variants (each containing a string) that make up the list of chart definition names known to the database. Each String contains the pathname of a single chart.

For Perl, a reference to an array of strings, each of which contains the pathname of a single chart.