ICalendarDimInstance.PeriodLength

Syntax

PeriodLength(El: Integer): Integer;

Parameters

El — element index.

Description

The PeriodLength method returns length of the period which includes the element passed by the El parameter. Period length is calculated in elements of the lower level of calendar dictionary.

Example

Sub UserProc;
Var
    MB: IMetabase;
    Obj: IMetabaseObjectDescriptor;
    CalClass: CalendarDimInstanceFactory;
    Dim: IDimInstance;
    CalInst: ICalendarDimInstance;
    i: Integer;
Begin
    Mb:=MetabaseClass.Active;
    Obj:=Mb.ItemById("CALENDAR_DIM");
    Dim:=Obj.Open(Null) As IDimInstance;
    CalClass:=New CalendarDimInstanceFactory.Create;
    CalInst:=CalClass.CreateCalendarDimInstance(Dim);
    i:=CalInst.PeriodLength(100);
End Sub UserProc;

After executing the example the "i" variable contains length of the period containing the 100th element of the calendar dictionary. Dictionary identifier: CALENDAR_DIM.