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

public DataSet EnumTimePeriods(
   string sessionID
)

C++

public:
 DataSet EnumTimePeriods(
   String sessionID
) sealed

JScript

public  function EnumTimePeriods(
   sessionID : String
) : DataSet

Parameters

Table 25. EnumTimePeriods Parameters

Parameter	Data Type	Description
sessionID	string	A session identifier

Returns

DataSet

Table 26. EnumTimePeriods DataSet

Parameter	Data Type	Description
ID	string	Time Period ID
ParentID	string	Pointer to parent Time Period, if it exists
Name	string	Time Period name
IsParent	bool	Indicates if the time period is a parent: true Is parent with children false Has no children
IsInput	bool	Indicates if ?: true ? false ?

Example