IRecurrencePattern::get_StartTime

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The StartTime property gets or sets a Variant time date object that represents the start time for a recurring appointment. Outlook Mobile ignores the date and uses only the time.

To get the value of the StartTime property, call the property method described here.

To set the value of the StartTime property, see the IRecurrencePattern::put_StartTime property method.

Syntax

HRESULT get_StartTime(
   DATE * pst
);

Parameters

• pst
  [out] Reference to a Variant time date object that represents the start time for a recurring appointment. For information on the DATE type, see IPOutlookApp::VariantTimeToSystemTime. For information on the SYSTEMTIME structure, see SYSTEMTIME.

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 Appointment items only. It is the difference between PIMPR_RECURRING_ENDTIME and PIMPR_RECURRING_STARTTIME.

The time returned is in the time zone of the appointment.

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::get_StartTime and IRecurrencePattern::get_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.

For Windows Mobile Version 5.0 and later, you must set the date values in IRecurrencePattern::get_StartTime and IRecurrencePattern::get_EndTime. The recurrence pattern's StartTime and EndTime must be equal to the time and date of one of the appointments in the recurrence series. If the appointment is less than a day, then the date portions of IRecurrencePattern::StartTime and IRecurrencePattern::EndTime must be equal.

The Start and End times for recurring Appointments are set in terms of the Timezone property (Calendar Property ID's), 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

See Also

Tasks

Creating a Recurring Appointment

Reference

IRecurrencePattern::put_StartTime
IRecurrencePattern
Pocket Outlook Object Model Interfaces