EnumTimePeriods

Description: Returns a list of time periods for the entity currently open in the HSFWebService.

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

Syntax

  • Visual Basic

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

    public DataSet EnumTimePeriods(
       string sessionID
    )
  • C++

    public:
     DataSet EnumTimePeriods(
       String sessionID
    ) sealed 
  • JScript

    public  function EnumTimePeriods(
       sessionID : String
    ) : DataSet

Parameters

Table 25. EnumTimePeriods Parameters

ParameterData TypeDescription
sessionIDstringA session identifier

Returns

DataSet

Table 26. EnumTimePeriods DataSet

ParameterData TypeDescription
IDstringTime Period ID
ParentIDstringPointer to parent Time Period, if it exists
NamestringTime Period name
IsParentboolIndicates if the time period is a parent:
  • true

    Is parent with children

  • false

    Has no children

IsInputboolIndicates if ?:
  • true

    ?

  • false

    ?

Example

See IncomeStatement.aspx.