IAppointment::get_AllDayEvent

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The AllDayEvent property gets or sets a value that indicates whether the Appointment is an All Day Event. By default, Appointments are not All Day Events.

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

To set the value of the AllDayEvent property, see the IAppointment::put_AllDayEvent property method.

Syntax

HRESULT get_AllDayEvent(
   VARIANT_BOOL * pfAllDay
);

Parameters

• pfAllDay
  [out] Reference to the Boolean flag. VARIANT_TRUE when the Appointment is an All Day Event. 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

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

Reference

IAppointment
Pocket Outlook Object Model Interfaces

Other Resources

Pocket Outlook Object Model Enumerations