IAppointment::put_AllDayEvent (Windows Embedded CE 6.0)
1/6/2010
The AllDayEvent property gets and sets a value that indicates whether the Appointment is an All Day Event. By default, Appointments are not All Day Events.
To set the value of the AllDayEvent property, call the property method described here.
To get the value of the AllDayEvent property, see the IAppointment::get_AllDayEvent property method.
Syntax
HRESULT put_AllDayEvent(
VARIANT_BOOL fAllDay
);
Parameters
- fAllDay
[in] Reference to the Boolean flag. 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 an Appointment is an All Day Event, then it cannot be a Meeting.
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 |
See Also
Reference
IAppointment
Pocket Outlook Object Model Interfaces