FrequencyType Property (SQL-DMO)

The FrequencyType property specifies the unit for the most significant portion of a Schedule object.

Applies To

Schedule Object

Syntax

object.FrequencyType [= value]

Part Description
object Expression that evaluates to an object in the Applies To list
value Long integer specifying an schedule evaluation frequency as described in Settings

Settings
Constant Value Description
SQLDMOFreq_Autostart 64 Scheduled activity is launched when SQL Server Agent starts.
SQLDMOFreq_Daily 4 Activity is scheduled to occur every n days. Set FrequencyInterval to indicate a value for n. Schedule a single occurrence time by setting ActiveStartTimeOfDay. Schedule multiple occurrence times by setting FrequencySubDay and FrequencySubDayInterval.
SQLDMOFreq_Monthly 16 Activity is scheduled to occur every n months. Set FrequencyRecurrenceFactor to indicate a value for n. Set FrequencyInterval to select the day of the month on which the activity occurs.
SQLDMOFreq_MonthlyRelative 32 Activity is scheduled to occur every n months on a day relative to the first day of the month. Set FrequencyRecurrenceFactor to indicate a value for n.
SQLDMOFreq_OneTime 1 Activity is scheduled to occur one time. Set ActiveStartDate and ActiveStartTimeOfDay to indicate the occurrence date and time.
SQLDMOFreq_OnIdle 128 Activity i

s scheduled to occur whenever SQL Server Agent is idle.

SQLDMOFreq_Unknown 0 Activity is not scheduled.
SQLDMOFreq_Weekly 8 Activity is scheduled to occur every n weeks. Set FrequencyRecurrenceFactor to indicate a value for n. Set FrequencyInterval to indicate the day(s) of the week on which the activity occurs.

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.

Data Type

Long, enumerated.

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFrequencyType(SQLDMO_FREQUENCY_TYPE* pRetVal);

HRESULT SetFrequencyType(SQLDMO_FREQUENCY_TYPE NewValue);

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.