IExecuteSubScheduledTask.SubName

Syntax

SubName: String;

Description

The SubName property determines a name of the procedure/function that should be started in the unit.

Example

Executing the example requires that the repository contains a scheduled tasks container with the TASK_CONTAINTER identifier and a unit with the Module_1 identifier. The unit contains the Main procedure.

Sub Main;

Var

MB: IMetabase;

CrInfo: IMetabaseObjectCreateInfo;

MObj: IMetabaseObject;

Exe: IExecuteSubScheduledTask;

Period: IScheduledTaskPeriodWeekly;

Prop: IScheduledTaskProperties;

Begin

MB := MetabaseClass.Active;

CrInfo := MB.CreateCreateInfo;

CrInfo.ClassID := MetabaseObjectClass.KE_CLASS_TASK_EXECUTESUB;

CrInfo.Id := "MODULE_EXECUTOR";

CrInfo.Name := "Unit execution";

CrInfo.Parent := MB.ItemById("TASK_CONTAINTER");

MObj := MB.CreateObject(CrInfo).Edit;

Exe := MObj As IExecuteSubScheduledTask;

Exe.Assembly := (MB.ItemById("Module_1").Bind As IModule).Assembly;

Exe.SubName := "Main";

Prop := Exe.Properties;

Period := Prop.CreatePeriod(ScheduledTaskPeriodType.Weekly) As IScheduledTaskPeriodWeekly;

Period.DaysOfWeek(CalendarDayOfWeek.Monday) := True;

Period.DaysOfWeek(CalendarDayOfWeek.Wednesday) := True;

Period.DaysOfWeek(CalendarDayOfWeek.Friday) := True;

Period.StartTime := DateTime.ComposeTimeOfDay(12, 0, 0, 0);

Prop.Period := Period;

MObj.Save;

End Sub Main;

After executing the example a new task of unit execution is created in the scheduled tasks container. The unit will be running on Mondays, Wednesdays and Fridays at 12:00.