IRecurrencePattern Properties (Windows CE 5.0)

Send Feedback

The IRecurrencePattern interface reads the properties described in the following tables.

Properties in Vtable Order

Property	Description
RecurrenceType HRESULT get_RecurrenceType (/* [out] */ long *plRecurrenceType); HRESULT put_RecurrenceType (/* [in] */ long lRecurrenceType);	Returns or sets the recurrence frequency for an Appointment or Task. When you set up a recurrence, you must set this property first. olRecursDaily olRecursWeekly olRecursMonthly olRecursMonthNth olRecursYearly olRecursYearNth
PatternStartDate HRESULT get_PatternStartDate (/* [out] */ DATE *pdaPatternStartDate); HRESULT put_PatternStartDate (/* [in] */ DATE daPatternStartDate);	Returns or sets the start date of the recurrence.
PatternEndDate HRESULT get_PatternEndDate (/* [out] */ DATE *pdaPatternEndDate); HRESULT put_PatternEndDate (/* [in] */ DATE daPatternEndDate);	Returns or sets the end date of the recurrence. To use this property, set NoEndDate to FALSE. After you set this property, NumberOfOccurrences is set automatically when you save the Task or Appointment. Not used if NoEndDate is TRUE.
NoEndDate HRESULT get_NoEndDate (/* [out] */ VARIANT_BOOL *pbNoEndDate); HRESULT put_NoEndDate (/* [in] */ VARIANT_BOOL bNoEndDate);	Returns or sets whether the recurrence has an end date. TRUE if the recurrence has no end date, or FALSE if the recurrence has an end date. If you set this to TRUE, PatternEndDate and Occurrences are not used.
Occurrences HRESULT get_Occurrences (/* [out] */ long *plOccurrences); HRESULT put_Occurrences (/* [in] */ long lOccurrences);	Returns or sets the number of occurrences. To use this property, set NoEndDate to FALSE. After you set this property, PatternEndDate is set automatically when you save the Task or Appointment. Not used if NoEndDate is TRUE.
StartTime HRESULT get_StartTime (/* [out] */ DATE *pdaStartTime); HRESULT put_StartTime (/* [in] */ DATE daStartTime);	Returns or sets the start time for a recurring appointment. Pocket Outlook ignores the date and uses only the time. The time returned is in the time zone of the appointment. Supported only for appointments.
Duration HRESULT get_Duration (/* [out] */ long *plDuration); HRESULT put_Duration (/* [in] */ long lDuration);	Returns or sets the duration for a recurring appointment. If you do not set this, Pocket Outlook sets it from the appointment. This is ignored if you set both StartTime and EndTime. It is used to calculate the other two if one or both is omitted. This cannot be set longer than 31 days. Supported only for appointments.
EndTime HRESULT get_EndTime (/* [out] */ DATE *pdaEndTime); HRESULT put_EndTime (/* [in] */ DATE daEndTime);	Returns or sets when a recurring appointment ends. Pocket Outlook uses only the time portion and ignores the date. The time returned is in the time zone of the Appointment. Supported only for appointments.
Exceptions HRESULT get_Exceptions (/* [out] */ Iexceptions **ppExceptions);	Returns a collection of exceptions to a recurring appointment. Changing the following properties on a single instance of a recurring appointment does not cause an exception. AllDayEvent Categories IsRecurring MeetingStatus ReminderOptions ReminderSoundFile Recipients Sensitivity Supported only for Appointments.

When you create a recurring Appointment, the IRecurrencePattern object gets the StartTime, Duration, and EndTime 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, 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 a RecurrencePattern 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.

The value of the RecurrenceType property determines whether you set the following properties. You must set the RecurrenceType property before setting any of these properties.

Property	Description	Valid for RecurrenceType
Interval HRESULT get_Interval (/* [out] */ long *plInterval); HRESULT put_Interval (/* [in] */ long lInterval);	The number of units between occurrences (days, weeks, months), from 1 to 999.	olRecursDaily olRecursMonthly olRecursMonthNth olRecursWeekly
DayOfWeekMask HRESULT get_DayOfWeekMask (/* [out] */ long *plDayOfWeekMask); HRESULT put_DayOfWeekMask (/* [in] */ long lDayOfWeekMask);	The days a pattern occurs — a combination of the day constants from olSunday through olSaturday.	olRecursMonthNth olRecursWeekly olRecursYearNth
DayOfMonth HRESULT get_DayOfMonth (/* [out] */ long *plDayOfMonth); HRESULT put_DayOfMonth (/* [in] */ long lDayOfMonth);	The day in any month a pattern occurs, from 1 to 31. If there are fewer days in a given month than the setting, the recurrence occurs on the last day of that month.	olRecursMonthly olRecursYearly
Instance HRESULT get_Instance (/* [out] */ long *plInstance); HRESULT put_Instance (/* [in] */ long lInstance);	The week of any month the recurrence occurs, from one to five. The value five is always the last week of the month, regardless of whether the calculated date actually exists.	olRecursMonthNth olRecursYearNth
MonthOfYear HRESULT get_MonthOfYear (/* [out] */ long *plMonthOfYear); HRESULT put_MonthOfYear (/* [in] */ long lMonthOfYear);	The month a recurrence occurs, from 1 to 12.	olRecursYearly olRecursYearNth

Return Values

Each property method supports the standard HRESULT return values, including S_OK.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Pimstore.h.
Link Library: Pimstore.lib.

See Also

IRecurrencePattern

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.