discard_alarm
Description:
[ Deprecated ( since = "3.2" ) ]
public bool discard_alarm (CalComponent comp, string auid) throws Error
public bool discard_alarm (CalComponent comp, string auid) throws Error
Warning: discard_alarm is deprecated.
Tells the calendar backend to get rid of the alarm identified by the auid
argument in comp
.
Some backends might remove the alarm or update internal information about the alarm be discarded, or, like the file backend does, ignore the operation.
CALOBJ_MOD_ONLY_THIS is not supported in this call.
Parameters:
comp |
The component to discard the alarm from. |
auid |
Unique identifier of the alarm to be discarded. |
Returns:
TRUE if the operation was successful, FALSE otherwise. |