Recurrence.RecurYearly(Int32, Int32, Int32) Method

Initialize a yearly recurrence that occurs on a specific month and day at the specified yearly interval.

Definition

Namespace: EWSoftware.PDI
Assembly: EWSoftware.PDI (in EWSoftware.PDI.dll) Version: 2025.1.9.0

C#View SourceRequest Example
public void RecurYearly(
	int month,
	int day,
	int recurInterval
)

VBView SourceRequest Example
Public Sub RecurYearly ( 
	month As Integer,
	day As Integer,
	recurInterval As Integer
)

C++View SourceRequest Example
public:
void RecurYearly(
	int month, 
	int day, 
	int recurInterval
)

F#View SourceRequest Example
member RecurYearly : 
        month : int * 
        day : int * 
        recurInterval : int -> unit 

Parameters

month Int32: The month in which to occur
day Int32: The day on which to occur
recurInterval Int32: The interval between occurrences in years

Remarks

This is a convenience method that mimics the yearly recurrence pattern in Microsoft Outlook. When called, it sets up the recurrence for a yearly pattern that recurs at the specified interval on the specified month and day. All rule parts are cleared prior to setting the yearly options but other parameters such as the start date are left alone.

Example

C#
// Test yearly recurrence
rRecur.RecurYearly(5, 24, 1);
rRecur.StartDateTime = DateTime.Today;
rRecur.RecurUntil = DateTime.Today.AddYears(5);

// With a collection
Dim recurDates = rRecur.InstancesBetween(DateTime.Today,
    DateTime.Today.AddYears(5));

// Using the enumerator
foreach(DateTime dt in recurDates)
    Console.WriteLine("Yearly recurrence on: {0:d}", dt);

foreach(DateTime dt in rRecur)
    Console.WriteLine("Yearly recurrence on: {0:d}", dt);

// Test yearly recurrence
rRecur.RecurYearly(DayOccurrence.Last, DaysOfWeek.Sunday, 9, 2);
rRecur.StartDateTime = DateTime.Today;

// With a collection
recurDates = rRecur.InstancesBetween(DateTime.Today, DateTime.Today.AddYears(5));

foreach(DateTime dt in recurDates)
    Console.WriteLine("Yearly recurrence on: {0:d}", dt);

// Using the enumerator
foreach(DateTime dt in rRecur)
    Console.WriteLine("Yearly recurrence on: {0:d}", dt);

VB
' Test yearly recurrence
rRecur.RecurYearly(5, 24, 1)
rRecur.StartDateTime = DateTime.Today
rRecur.RecurUntil = DateTime.Today.AddYears(5)

' With a collection
Dim recurDates As DateTimeCollection = rRecur.InstancesBetween(DateTime.Today,
    DateTime.Today.AddYears(5))

' Using the enumerator
For Each dt In recurDates
    Console.WriteLine("Yearly recurrence on: {0:d}", dt)
Next

For Each dt In rRecur
    Console.WriteLine("Yearly recurrence on: {0:d}", dt)
Next

' Test yearly recurrence
rRecur.RecurYearly(DayOccurrence.Last, DaysOfWeek.Sunday, 9, 2)
rRecur.StartDateTime = DateTime.Today

' With a collection
recurDates = rRecur.InstancesBetween(DateTime.Today, DateTime.Today.AddYears(5))

For Each dt In recurDates
    Console.WriteLine("Yearly recurrence on: {0:d}", dt)
Next

' Using the enumerator
For Each dt In rRecur
    Console.WriteLine("Yearly recurrence on: {0:d}", dt)
Next

C++

No code example is currently available or this language may not be supported.

F#

No code example is currently available or this language may not be supported.

Exceptions

ArgumentOutOfRangeException	An exception is thrown if the month is not between 1 and 12.
ArgumentException	An exception is thrown if the day is not valid for the specified month.