Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

The IncludeRecurrencesproperty gets and sets a value that indicates whether to include Appointment recurrence instances in a collection of Appointment items (sorted on the IAppointment::get_Startproperty, in ascending order).

To set the value of the IncludeRecurrencesproperty, call the property method described here.

To get the value of the IncludeRecurrencesproperty, see the IPOutlookItemCollection::get_IncludeRecurrencesproperty method.

Syntax 

HRESULT put_IncludeRecurrences(
   VARIANT_BOOL 
fIncludeRecurrences
);

Parameters

fIncludeRecurrences

[in] Reference to a Boolean flag. VARIANT_TRUEif Appointment recurrence instances are included. For information about the VARIANT_BOOLtype, see the union member of the PROPVARIANTstructure.

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

If VARIANT_TRUE, recurring Appointments are expanded to all dates upon which they occur. If VARIANT_FALSE(the default), recurring Appointments are only associated with the first day upon which they occur.

Set this property to VARIANT_TRUEwhen you want to find all Appointments that fall on a specific date.

The VARIANT_BOOLdata type (also known as VT_BOOL) uses the value -1 to represent TRUEand 0 to represent FALSE. It is defined in the wtypes.hheader file in the following manner:

Copy Code 
typedef short 
VARIANT_BOOL;

A common programming error occurs when, for readability purposes, you want to set a VARIANT_BOOLvalue to TRUEor FALSE. You can achieve the same effect by using the aliases VARIANT_TRUEand VARIANT_FALSE, which are also defined in the wtypes.hheader file.

Copy Code 
#define 
VARIANT_TRUE  ((VARIANT_BOOL)0xffff)
#define 
VARIANT_FALSE ((VARIANT_BOOL)0)

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