IRecurrencePattern::get_Interval

Article
08/28/2006

The Interval property gets or sets the number of units between occurrences (days, weeks, months), from 1 to 999.

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

To set the value of the Interval property, see the IRecurrencePattern::put_Interval property method.

Syntax

HRESULT get_Interval(
  long * plInterval
);

Parameters

plInterval
[out] Reference to the number of units between occurrences.

Return Values

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

To interpret plInterval correctly, you need to know the type of recurrence (that is., the units of measure). You can call IRecurrencePattern::get_RecurrenceType to find out.

See the OlRecurrenceType enumeration for details about the recurrence types.

You must set the RecurrenceType property before setting this property.

Requirements

Smartphone: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: pimstore.h
Library: pimstore.lib

Share via