FrequencyRecurrenceFactor Property

SQL-DMO

SQL-DMO

FrequencyRecurrenceFactor Property

The FrequencyRecurrenceFactor property controls evaluation of the most significant portion of a Microsoft® SQL Server™ schedule.

Applies To
Schedule Object
Syntax

object.FrequencyRecurrenceFactor [= value]

Part

object

Expression that evaluates to an object in the Applies To list

value

Long integer greater than or equal to 1 and indicating a number of weeks or months

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFrequencyRecurrenceFactor(LPLONG pRetVal);

HRESULT SetFrequencyRecurrenceFactor(LONG NewValue);

Remarks

The FrequencyRecurrenceFactor property is evaluated for Schedule objects with FrequencyType values SQLDMOFreq_Monthly, SQLDMOFreq_MonthlyRelative, or SQLDMOFreq_Weekly.

The FrequencyRecurrenceFactor property indicates a number of units of the unit type indicated by the FrequencyType property. For example, when FrequencyType is SQLDMOFreq_Weekly, FrequencyRecurrenceFactor indicates a number of weeks. Setting FrequencyRecurrenceFactor to 2 indicates an activity scheduled to occur every other week.

FrequencyType value Action
SQLDMOFreq_Monthly Set FrequencyInterval to indicate the day of the month on which the activity occurs.
SQLDMOFreq_MonthlyRelative Set FrequencyInterval to indicate the single day of the week on which the activity occurs. Set FrequencyRelativeInterval to indicate the day of the week relative to the start of the month.
SQLDMOFreq_Weekly Set FrequencyInterval to indicate the day(s) of the week on which the activity occurs.