Name

cancelEvent — cancel an already scheduled alarm.

Synopsis

void cancelEvent(const QString& calendarFile, const QString& eventID)

Parameters

calendarFile

Specifies the URL of the calendar file containing the event to be canceled.

eventID

Specifies the unique ID of the event to be canceled, as stored in calendarFile.

Description

cancelEvent() is a DCOP call to cancel the specified alarm. KAlarm deletes the alarm from the calendar file without displaying or executing it.

Note

The calendarFile parameter is only used for integrity checking: if the URL does not specify KAlarm's current default calendar file, the request will be ignored.

Note

The old name for this function, cancelMessage, has been retained for compatibility, but all new applications should use cancelEvent.