IPOutlookItemCollection::get_IncludeRecurrences
A version of this page is also available for
4/8/2010
The IncludeRecurrences property gets and sets a value that indicates whether Appointment Recurrence instances are included in a collection of Appointment items (sorted on the Start property, in ascending order).
To get the value of the IncludeRecurrences property, call the property method described here.
To set the value of the IncludeRecurrences property, see the IPOutlookItemCollection::put_IncludeRecurrences property method.
Syntax
HRESULT get_IncludeRecurrences(
VARIANT_BOOL * pfIncludeRecurrences
);
Parameters
- pfIncludeRecurrences
[out] Reference to a Boolean flag. VARIANT_TRUE if Appointment Recurrence instances are included. For information about the VARIANT_BOOL type, see the union member of the PROPVARIANT structure.
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 associated only with the first day upon which they occur.
Set this property to VARIANT_TRUE when you want to find all Appointments that fall on a specific date.
The VARIANT_BOOL data type (also known as VT_BOOL) uses the value -1 to represent TRUE and 0 to represent FALSE. It is defined in the wtypes.h header file in the following manner:
typedef short VARIANT_BOOL;
A common programming error occurs when, for readability purposes, you want to set a VARIANT_BOOL value to TRUE or FALSE. You can achieve the same effect by using the aliases VARIANT_TRUE and VARIANT_FALSE, which are also defined in the wtypes.h header file.
#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
Reference
IPOutlookItemCollection::put_IncludeRecurrences
IPOutlookItemCollection
Pocket Outlook Object Model Interfaces