FrequencyInterval Property

SQL-DMO

SQL-DMO

FrequencyInterval Property

The FrequencyInterval property defines the most significant portion of a Microsoft® SQL Server™ schedule for daily, weekly, or monthly schedules.

Applies To
Schedule Object
Syntax

object.FrequencyInterval [= value]

Part

object

Expression that evaluates to an object in the Applies To list

value

Long integer that specifies a schedule frequency interval as described in Settings

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFrequencyInterval(LPLONG pRetVal);

HRESULT SetFrequencyInterval(LONG NewValue);

Settings

FrequencyInterval is always interpreted relative to the value of the FrequencyType property. For some FrequencyType values, FrequencyInterval is a bit-packed long integer. FrequencyInterval is interpreted using these values.

FrequencyType value FrequencyInterval value
SQLDMOFreq_Daily Positive, long integer that represents a number of day units. For example, when FrequencyInterval is 3, the scheduled activity occurs every third day.
SQLDMOFreq_Weekly Bit-packed long integer. Values are interpreted using SQLDMO_WEEKDAY_TYPE naming the days of the week. Combine values using an OR logical operator to set more than a single day. For example, combine SQLDMOWeek_Tuesday and SQLDMOWeek_Friday to schedule an activity for Tuesday and Friday.
SQLDMOFreq_Monthly Positive, long integer that represents the ordinal day of the month on which the schedule is active. For example, 4 specifies the fourth day of the month.
SQLDMOFreq_MonthlyRelative Positive, long integer that represents a day of the week or a generic indication of a day. Values are interpreted using SQLDMO_MONTHDAY_TYPE.

Remarks

The FrequencyInterval property is valid for Schedule objects with FrequencyType SQLDMOFreq_Daily, SQLDMOFreq_Weekly, SQLDMOFreq_Monthly, or SQLDMOFreq_MonthlyRelative.