OlReminderOptions

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The OlReminderOptions enumeration identifies the kind of reminder used for Appointment and Task items.

Syntax

enum OlReminderOptions {
  olLED     = 1,
  olVibrate = 2,
  olDialog  = 4,
  olSound   = 8,
  olRepeat  = 16
};

Elements

• olLED
  The mobile device's Light Emitting Diode (LED) illuminates to visibly announce the reminder.

• olVibrate
  The mobile device's built-in vibrator vibrates to announce the reminder.

• olDialog
  A dialog box appears on the screen to visibly announce the reminder.

• olSound
  The mobile device plays a wave file to audibly announce the reminder.

• olRepeat
  The reminder repeats until the user acknowledges it.

Remarks

The values in this enumeration are in a sequence that doubles between values. This allows you to specify combinations of multiple values by combining individual values with the bitwise OR. For example, the value 6 is interpreted to mean both 2 and 4 together.

Example

The following code example demonstrates how to set an appointment reminder to vibrate and repeat until acknowledged by the user. The variable pAppt is a pointer to an item of type IAppointment.

IAppointment * pAppt;
SYSTEMTIME     st;
DATE           date;

// Create an Appointment item from the POOM application object.
polApp->CreateItem(olAppointmentItem, (IDispatch**)&pAppt);

// Convert the date Monday, 5/10/2007 at 8:30 PM to a DATE object.
memset(&st, 0, sizeof(SYSTEMTIME));

st.wMonth = 5;
st.wDay   = 10;
st.wYear  = 2007;
st.wHour  = 20.5;

polApp->SystemTimeToVariantTime(&st, &date);

// Set the appointment's subject, start date, and reminder.
hr = pAppt->put_Subject(TEXT ("Test Appointment"));
hr = pAppt->put_Start(date);
hr = pAppt->put_ReminderOptions(olVibrate | olRepeat);

// Save the Appointment item.
hr = pAppt->Save();

To make the code example easier to read, security checking and error handling are not included. This code example should not be used in a release configuration unless it has been modified to include them.

Requirements

See Also

Tasks

Creating a PIM Item

Reference

Pocket Outlook Object Model Interfaces
Calendar and Task Property ID's
IAppointment::put_ReminderOptions
ITask::put_ReminderOptions

Other Resources

Pocket Outlook Object Model Enumerations