IRecurrencePattern

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The IRecurrencePattern interface provides read-write access to recurrence pattern objects associated with Task and Appointment items. You can get an IRecurrencePattern object by calling either ITask::GetRecurrencePattern or IAppointment::GetRecurrencePattern

Methods in Vtable Order

• IUnknown methods
• IDispatch methods

IRecurrencePattern methods	Description
IRecurrencePattern::get_RecurrenceType	Gets an integer value that represents the recurrence type for an appointment or task.
IRecurrencePattern::get_PatternStartDate	Gets a Variant time date object that represents the start date of the recurrence pattern.
IRecurrencePattern::get_StartTime	Gets a Variant time date object that represents the start time for a recurring appointment.
IRecurrencePattern::get_EndTime	Gets a Variant time date object that represents the end of a recurring appointment.
IRecurrencePattern::get_PatternEndDate	Gets a Variant time date object that represents the end date of the recurrence.
IRecurrencePattern::get_NoEndDate	Gets a Boolean value indicating whether the recurrence has an end date.
IRecurrencePattern::get_Occurrences	Gets an integer value indicating the number of occurrences in the recurrence pattern.
IRecurrencePattern::get_Interval	Gets the number of units between occurrences (days, weeks, months), from 1 to 999.
IRecurrencePattern::get_DayOfWeekMask	Gets a bitmask that represents the combination of OlDaysOfWeek enumeration values that make up a recurrence pattern.
IRecurrencePattern::get_DayOfMonth	Gets a value between 1 and 31, inclusive, that represents a recurrence pattern expressed as a day of the month.
IRecurrencePattern::get_Instance	Gets an integer value between 1 and 5, inclusive, that represents a recurrence pattern expressed as a week of the month.
IRecurrencePattern::get_Duration	Gets the length of a recurring appointment.
IRecurrencePattern::get_MonthOfYear	Gets an integer value between 1 and 12, inclusive, that represents a recurrence pattern expressed as a month of the year.
IRecurrencePattern::put_RecurrenceType	Sets the type of recurrence for Appointment and Task items.
IRecurrencePattern::put_PatternStartDate	Sets the start date of the recurrence pattern.
IRecurrencePattern::put_StartTime	Sets the start time of the recurrence pattern.
IRecurrencePattern::put_EndTime	Sets the end time of the recurrence pattern.
IRecurrencePattern::put_PatternEndDate	Sets the end date of the recurrence pattern.
IRecurrencePattern::put_NoEndDate	Sets a Boolean value indicating whether the recurrence pattern has an end date.
IRecurrencePattern::put_Occurrences	Sets the number of occurrences in the recurrence pattern.
IRecurrencePattern::put_Interval	Sets the time span between occurrences (days, weeks, months), from 1 to 999.
IRecurrencePattern::put_DayOfWeekMask	Sets a bitmask that represents the combination of OlDaysOfWeek enumeration values that make up a recurrence pattern.
IRecurrencePattern::put_DayOfMonth	Sets a recurrence pattern expressed as a day of the month.
IRecurrencePattern::put_Instance	Sets the duration of a recurrence pattern expressed as a day of the week, a week of the month, or a month of the year.
IRecurrencePattern::put_Duration	Sets the duration of a recurrence pattern expressed as a day of the week, a week of the month, or a month of the year.
IRecurrencePattern::put_MonthOfYear	Sets a recurrence pattern expressed as a month of the year.
IRecurrencePattern::get_Exceptions	Gets a collection of exceptions that are associated with a recurring appointment object.
IRecurrencePattern::get_Application	Gets the main Outlook Mobile IPOutlookApp object.
IRecurrencePattern::GetOccurrence	Gets a specific instance of an appointment for a specific date.

Remarks

When you create a recurring Appointment, the IRecurrencePattern object gets the StartTime, Duration, and EndTime values from the appointment, so you do not need to set them. If you do set these values, your settings override the Appointment settings. If you set all three properties: StartTime, Duration, and EndTime, Outlook Mobile ignores the Duration setting and defines the Appointment with the StartTime and EndTime settings. If you set any two of these properties and leave the third property undefined, then Outlook Mobile calculates the undefined setting from the other two properties.

To set the start date of an IRecurrencePattern object, use the PatternStartDate property. For Appointments, the Duration property of an IRecurrencePattern object cannot be longer than 31 days. Furthermore, the minimum period between instances of a recurring appointment cannot be less than the duration of the appointment. Otherwise, appointment instances would overlap.

Requirements

Header	pimstore.h
Library	Pimstore.lib
Windows Embedded CE	Windows CE 2.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Tasks

Creating a Recurring Appointment

Reference

Pocket Outlook Object Model Interfaces

Other Resources

Pocket Outlook Object Model Enumerations