FrequencyType Property
The FrequencyType property specifies the unit for the most significant portion of a Schedule object.
Applies To
| Schedule Object |
Syntax
object.FrequencyType [= value]
Part
object
Expression that evaluates to an object in the Applies To list
value
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 | Scheduled activity is started when SQL Server Agent service starts. |
| SQLDMOFreq_Daily | 4 | Schedule is evaluated daily. |
| SQLDMOFreq_Monthly | 16 | Schedule is evaluated monthly. |
| SQLDMOFreq_MonthlyRelative | 32 | Schedule is evaluated relative to a part of a month, such as the second week. |
| SQLDMOFreq_OneTime | 1 | Scheduled activity will occur once at a scheduled time or event. |
| SQLDMOFreq_OnIdle | 128 | SQL Server Agent service will schedule the activity for any time during which the processor is idle. |
| SQLDMOFreq_Unknown | 0 | No schedule frequency, or frequency not applicable. |
| SQLDMOFreq_Valid | 255 | Mask to test schedule frequency validity. |
| SQLDMOFreq_Weekly | 8 | 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.