Deletes an event from the calendar


See also Calendar functions.

Signature:

CalendarContextEventRemove([monthOffset,] day, index)

Arguments:

  • monthOffset - Month containing an event relative to the calendar's currently displayed month (number)

    • -1 - Month preceding the calendar's current month
    • 0 - The calendar's current month (i.e. same month as CalendarGetMonth())
    • 1 - Month after the calendar's current month
    • nil - Use the event selected by CalendarContextSelectEvent and ignore further arguments

  • day - Day of the month containing an event (number)

  • index - Index of an event on the given day (from 1 to CalendarGetNumDayEvents()) (number)

This function does not prompt the user for confirmation before its results take effect -- that behavior is provided by the default UI, and this function is called from the confirmation dialog