IAppointment::put_ReminderSoundFile

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The ReminderSoundFile property gets or sets the path and file name of the sound file to play when the reminder occurs for the Appointment.

To set the value of the ReminderSoundFile property, call the property method described here.

To get the value of the ReminderSoundFile property, see the IAppointment::get_ReminderSoundFile property method.

Syntax

HRESULT put_ReminderSoundFile(
   BSTR pwsz
);

Parameters

  • pwsz
    [in] Reference to the path and file name. For information on the BSTR type, see BSTR.

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

This property is valid only if the ReminderSet property is TRUE and the ReminderOptions property includes the OlReminderOptions enumeration value olSound. The reminder sound file is the current setting for the Calendar application and must be explicitly set.

Maximum length is limited to MAX_PATH (261) chars.

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

IAppointment
Pocket Outlook Object Model Interfaces

Other Resources

Pocket Outlook Object Model Enumerations