| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Events.RemoveEvent
Removes an event from the calendar store.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Events | 6.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "Events.RemoveEvent"; EKEvent; Span { ; Commit } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| EKEvent | The reference to the event. | $event | |
| Span | The span to use. This event, or this and future events. Pass "This" or "Future" here. |
"This" | |
| Commit | Whether to commit. Pass 1 to commit or 0 to not commit. Default is 1. Pass 0 to batch changes together and commit with Events.Commit later. |
1 | Optional |
Result
Returns OK or error.
Description
Removes an event from the calendar store.This function attempts to remove the event from the calendar database. It returns OK if successful and error otherwise. It's possible for this function to return failed. This occurs if the event wasn't ever added and didn't need removing.
After an event is removed, it is no longer tied to this calendar store, and all data in the event is cleared except for the eventIdentifier.
You may still need to call Events.Commit later.
Examples
Remove event:
Set Variable [$r; Value:MBS("Events.RemoveEvent"; CalendarTest::ItemUID; "this"; 1)]
See also
Release notes
- Version 14.5
- Fixed a problem with Events.Reset with not clearing all cached events, so Events.RemoveEvent function failed.
Example Databases
Blog Entries
FileMaker Magazin
This function checks for a license.
Created 10th March 2016, last changed 17th March 2021
