IRecurrencePattern
The IRecurrencePattern interface provides read-write access to tasks and appointment recurrence patterns.
You get an IRecurrencePattern object by calling either ITask::GetRecurrencePattern or IAppointment::GetRecurrencePattern.
Methods in Vtable Order
| IRecurrencePattern methods | Description |
|---|---|
| get_RecurrenceType | Gets an integer value that represents the recurrence type for an appointment or task. |
| get_PatternStartDate | Gets a Variant time date object that represents the start date of the recurrence pattern. |
| get_StartTime | Gets a Variant time date object that represents the start time for a recurring appointment. |
| get_EndTime | Gets a Variant time date object that represents the end of a recurring appointment. |
| get_PatternEndDate | Gets a Variant time date object that represents the end date of the recurrence. |
| get_NoEndDate | Gets a Boolean value indicating whether the recurrence has an end date. |
| get_Occurrences | Gets an integer value indicating the number of occurrences in the recurrence pattern. |
| get_Interval | Gets the number of units between occurrences (days, weeks, months), from 1 to 999. |
| get_DayOfWeekMask | Gets a bitmask that represents the combination of OlDaysOfWeek enumeration values that make up a recurrence pattern. |
| get_DayOfMonth | Gets a value between 1 and 31, inclusive, that represents a recurrence pattern expressed as a day of the month. |
| get_Instance | Gets an integer value between 1 and 5, inclusive, that represents a recurrence pattern expressed as a week of the month. |
| get_Duration | Gets the length of time that an appointment recurs. |
| get_MonthOfYear | Gets an integer value between 1 and 12, inclusive, that represents a recurrence pattern expressed as a month of the year. |
| put_RecurrenceType | Sets the type of recurrence for Appointment and Task items. |
| put_PatternStartDate | Sets the start date of the recurrence pattern. |
| put_StartTime | Sets the start time of the recurrence pattern. |
| put_EndTime | Sets the end time of the recurrence pattern. |
| put_PatternEndDate | Sets the end date of the recurrence pattern. |
| put_NoEndDate | Sets a Boolean value indicating whether the recurrence pattern has an end date. |
| put_Occurrences | Sets the number of occurrences in the recurrence pattern. |
| put_Interval | Sets the time span between occurrences (days, weeks, months), from 1 to 999. |
| put_DayOfWeekMask | Sets a bitmask that represents the combination of OlDaysOfWeek enumeration values that make up a recurrence pattern. |
| put_DayOfMonth | Sets a recurrence pattern expressed as a day of the month. |
| put_Instance | Sets the duration of a recurrence pattern expressed as a week of the month. |
| put_Duration | Sets the length of time that an appointment recurs. |
| put_MonthOfYear | Sets a recurrence pattern expressed as a month of the year. |
| get_Exceptions | Gets a collection of exceptions that are associated with a recurring appointment object. |
| get_Application | Gets the main Pocket Outlook IPOutlookApp object. |
| 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, EndTime—Pocket Outlook 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 undefined, Pocket Outlook calculates the undefined setting from the two properties you set.
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.
To set the end date of an IRecurrencePattern object, use the PatternEndDate property. Appointments can recur a maximum of 999 times. Therefore the maximum end-date that can be specified for any new Appointment is calculated by to the following formula:
Current Date+(Days_between_recurrences*999).
Requirements
Smartphone: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: pimstore.h
Library: pimstore.lib
See Also
How to: Create a Recurring Appointment
Pocket Outlook Object Model API Interfaces
Pocket Outlook Object Model API Enumerations
Last updated on Friday, April 22, 2005
© 2005 Microsoft Corporation. All rights reserved.
Send feedback on this topic to the authors.