EnumScenarios

Description: Returns a list of scenarios for the entity currently open in the HSF Gateway.

Prerequisites: CreateSession(), OpenServer(), OpenDatabase() and OpenEntity().

Syntax

  • Visual Basic

    Public Function EnumScenarios( _ 
       ByVal sessionID As String _ 
    ) As DataSet
  • C#

    public DataSet EnumScenarios(
       string sessionID
    )
  • C++

    public:
     DataSet EnumScenarios(
       String sessionID
    ) sealed 
  • JScript

    public  function EnumScenarios(
       sessionID : String
    ) : DataSet

Parameters

Table 23. Parameters

ParameterData TypeDescription
sessionIDstringA session identifier

Returns

DataSet

Table 24. EnumScenarios DataSet

ParameterData TypeDescription
IDstringScenario ID
NamestringScenario name

Example

See IncomeStatement.aspx.