FrequencyInterval Property
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The FrequencyInterval property defines the most significant portion of a Microsoft SQL Server schedule for daily, weekly, or monthly schedules.
Syntax
object
.FrequencyInterval [=value]
Parts
- object
An expression that evaluates to an object in the Applies To list.
- value
A 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 |
A positive, long integer that represents a number of day units. For example, if FrequencyInterval is 3, the scheduled activity occurs every third day. |
SQLDMOFreq_Weekly |
A bit-packed long integer. Values are interpreted using SQLDMO_WEEKDAY_TYPE, which names 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 |
A 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 |
A 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 a FrequencyType value of SQLDMOFreq_Daily, SQLDMOFreq_Weekly, SQLDMOFreq_Monthly, or SQLDMOFreq_MonthlyRelative.