IAdmRecurrencePattern

The IAdmRecurrencePattern interface represents a schedule for a recurring event, like scheduled task execution or rule-based group membership update.

Inheritance: IUnknown

Methods

Properties

  • Property

  • Description

  • RecurrenceType

  • Gets or sets the schedule type.

  • PatternStartDateTime

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

  • NotBeforeDateTime

  • Gets or sets the earliest date and time of the first execution.

  • Interval

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

  • DayOfWeekMask

  • Gets or sets the days of week when the event should occur.

  • DayOfMonth

  • Gets or sets the day of the month when the event should occur.

Details

All dates and times are in the local time zone of the computer where Adaxes service is running.

CalcNextRunTime()

Returns the date and time of the next scheduled event.

DateTime CalcNextRunTime(DateTime lastRunTime)

Parameters

  • lastRunTime – the date and time when the event last occured.

RecurrenceType

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

PatternStartDateTime

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

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

NotBeforeDateTime

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

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

Remarks

This property takes effect only if the recurrence pattern is applied to a scheduled task.

If set, the task will follow its recurrence pattern but will not be executed until this date. For example, if a task is configured to run on the 11th of each month and this property is set to November 12, 2025, the task will run for the first time on December 11, 2025.

Interval

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

  • 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 event occurrences.

DayOfWeekMask

Gets or sets the days of week when the event should occur.

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 when the event should occur.

  • 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