IRecurrencePattern::get_Duration
A version of this page is also available for
4/8/2010
The Duration property gets or sets the length of a recurring Appointment, in minutes (not the length of time that the recurrence pattern lasts).
To get the value of the Duration property, call the property method described here.
To set the value of the Duration property, see the IRecurrencePattern::put_Duration property method.
Syntax
HRESULT get_Duration(
long * plDuration
);
Parameters
- plDuration
[out] Reference to an integer value indicating the length of time, in minutes, of the recurring Appointment.
Return Value
This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:
- S_OK
The method completed successfully.
Remarks
Recurrence duration applies to IAppointment items only.
Recurrence duration is the difference between PIMPR_RECURRING_ENDTIME and PIMPR_RECURRING_STARTTIME.
If you do not set the duration, Outlook Mobile sets it from information contained in the Appointment item.
The Duration value is ignored if you set both IRecurrencePattern::put_StartTime and IRecurrencePattern::put_EndTime. If you set only one, Outlook Mobile uses the Duration value to calculate the other.
The Duration value cannot be longer than 31 days.
When you change a Recurrence Pattern's Duration property, the Duration property of each Appointment item that is associated with this Recurrence Pattern also changes. For example, you might use IRecurrencePattern::put_Duration if you wanted to change the duration of a weekly meeting from 60 minutes, to 30 minutes.
The Start and End times for recurring Appointments are set in terms of the Timezone property (PIMPR_TIMEZONE), but the Start and End times for individual Appointments are set and read in terms of the local (Windows Mobile device's) Timezone. For example, a recurring Appointment set to recur at noon London time, would occur at 4:00 AM Pacific time.
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
IRecurrencePattern::put_Duration
IRecurrencePattern
Pocket Outlook Object Model Interfaces