FrequencyType 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 FrequencyType property specifies the unit for the most significant portion of a Schedule object.
Syntax
object.FrequencyType [=value]
Parts
object
An expression that evaluates to an object in the Applies To list.value
A long integer that specifies a schedule evaluation frequency as described in Settings.
Data Type
Long, enumerated
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetFrequencyType(SQLDMO_FREQUENCY_TYPE* pRetVal);
HRESULT SetFrequencyType(SQLDMO_FREQUENCY_TYPE NewValue);
Settings
Constant |
Value |
Description |
|---|---|---|
SQLDMOFreq_Autostart |
64 |
The scheduled activity is started when the SQL Server Agent service starts. |
SQLDMOFreq_Daily |
4 |
The schedule is evaluated daily. |
SQLDMOFreq_Monthly |
16 |
The schedule is evaluated monthly. |
SQLDMOFreq_MonthlyRelative |
32 |
The schedule is evaluated relative to a part of a month, such as the second week. |
SQLDMOFreq_OneTime |
1 |
The scheduled activity occurs once, at a scheduled time or event. |
SQLDMOFreq_OnIdle |
128 |
The SQL Server Agent service schedules the activity for any time during which the processor is idle. |
SQLDMOFreq_Unknown |
0 |
Schedule frequency is not set, or frequency is not applicable. |
SQLDMOFreq_Valid |
255 |
A mask to test schedule frequency validity. |
SQLDMOFreq_Weekly |
8 |
The schedule is evaluated weekly. |
Remarks
Setting FrequencyType may require setting other property values to schedule an activity accurately. For example, setting FrequencyType to SQLDMOFreq_Weekly without setting the FrequencyInterval property to specify days of the week results in an unscheduled activity.
For more information about setting frequency values, see FrequencyInterval Property, FrequencyRecurrenceFactor Property, FrequencySubDay Property, and FrequencySubDayInterval Property.