IRecurrencePattern::get_NoEndDate (Windows Embedded CE 6.0)

1/6/2010

The NoEndDate property gets and sets a Boolean value that indicates whether the recurrence pattern has an end date. The value is VARIANT_TRUE when the recurrence has no end date, and VARIANT_FALSE when the recurrence has an end date.

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

To set the value of the NoEndDate property, see the IRecurrencePattern::put_NoEndDate property method.

Syntax

HRESULT get_NoEndDate(
   VARIANT_BOOL * pfNoEndDate
);

Parameters

• pfNoEndDate
  [out] Reference to a Boolean value indicating whether the recurrence has an end date. VARIANT_TRUE when there is no end date. 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 you set this value to VARIANT_TRUE, then PatternEndDate and Occurrences are not used.

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

See Also

Tasks

Creating a Recurring Appointment

Reference

IRecurrencePattern
IRecurrencePattern::put_NoEndDate
Pocket Outlook Object Model Interfaces