IAdmRecurrencePattern

The IAdmRecurrencePattern interface represents the pattern of incidence of recurring tasks.

Inheritance: IUnknown

Methods

  • Method

  • Description

  • CalcNextRunTime()

  • Returns the date and time of the next scheduled execution of the task.

Properties

  • Property

  • Description

  • RecurrenceType

  • Gets or sets the type of schedule recurrence.

  • PatternStartDateTime

  • Gets or sets the start date and time of the recurrence pattern.

  • NotBeforeDateTime

  • Gets or sets the date and time before which the task must not be executed.

  • Interval

  • Gets or sets the number of units (minutes, hours or days) between occurrences of the task.

  • DayOfWeekMask

  • Gets or sets the days of week on which the task is to be executed.

  • DayOfMonth

  • Gets or sets the day of the month on which the task is to be executed.

Details

CalcNextRunTime()

Returns the date and time of the next scheduled execution of the task.

DateTime CalcNextRunTime(DateTime lastRunTime)

Parameters

The lastRunTime parameter specifies the date and time when the task was last executed in the local time zone of the computer where Adaxes service is running.

Return value

The method returns the date and time in the local time zone of the computer where Adaxes service is running.

RecurrenceType

Gets or sets the type of schedule recurrence (once, minutely, hourly, daily, weekly or monthly).

PatternStartDateTime

Gets or sets the start date and time of the recurrence pattern in the local time zone of the computer where Adaxes service is running.

  • Type:
  • DateTime
  • Access:
  • Read/Write

NotBeforeDateTime

Gets or sets the date and time before which the task must not be executed in the local time zone of the computer where Adaxes service is running.

  • Type:
  • DateTime
  • Access:
  • Read/Write

Interval

Gets or sets the number of units (minutes, hours or days) between occurrences of the task.

  • Type:
  • int
  • Access:
  • Read/Write

Remarks

The property takes effect only if the RecurrenceType property is set to ADM_RECURRENCEPATTERNTYPE_MINUTELY, ADM_RECURRENCEPATTERNTYPE_HOURLY or ADM_RECURRENCEPATTERNTYPE_DAILY. Depending on the recurrence type, this property determines the number of minutes, hours or days between occurrences of the task

DayOfWeekMask

Gets or sets the days of week on which the task is to be executed.

Remarks

The property gets or sets a bitmask that represents a combination of the ADM_DAYSOFWEEK_ENUM enumeration values that make up a recurrence pattern. The property takes effect only if the RecurrenceType property is set to ADM_RECURRENCEPATTERNTYPE_WEEKLY.

DayOfMonth

Gets or sets the day of the month on which the task is to be executed.

  • Type:
  • int
  • Access:
  • Read/Write

Remarks

The value must be between 1 and 31, inclusive, or -1 for the last day in month. The property takes effect only if the RecurrenceType property is set to ADM_RECURRENCEPATTERNTYPE_MONTHLY.

Requirements

Minimum required version: 2011.2

See also

© Softerra 2022. All rights reserved.
Send feedback