IRecurrencePattern::get_Instance

Send Feedback

The Instance property gets or sets the duration of a recurrence pattern expressed as a day of the week, a week of the month, or a month of the year.

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

To set the value of the Instance property, see the IRecurrencePattern::put_Instance property method.

Syntax

HRESULT get_Instance(
  long * plInstance
);

Parameters

  • plInstance
    [out] An integer value indicating the day of the week, the week of the month, or the month of the year in which the recurrence pattern occurs.

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

Valid for OlRecurrenceType enumeration recurrence types olRecursMonthNth, and olRecursYearNth.

For a recurrence type of olRecursMonthNth, pIInstance is a reference to an integer value between 1 and 5, inclusive, that represents a recurrence pattern expressed as a week of the month. In this case, the value five always represents the last week of the month.

You must set the RecurrenceType property before setting this property.

Requirements

Pocket PC: Pocket PC 2000 and later
Smartphone: Smartphone 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 | IRecurrencePattern::put_Instance | IRecurrencePattern | Pocket Outlook Object Model API Interfaces

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.