Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5   7.6    Statistic  

Events.RemoveEvent

Removes an event from the calendar store.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Events 6.2 Yes No Yes, macOS only No No

MBS( "Events.RemoveEvent"; EKEvent; Span { ; Commit } )

Parameters

Parameter Description Example value
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 Optional
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

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.

Examples

Remove event:

Set Variable [$r; Value:MBS("Events.RemoveEvent"; CalendarTest::ItemUID; "this"; 1)]

See also


Events.RemoveCalendar   -   Events.RemoveReminder

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins