Actr_DeleteEvent (function reference)

By September 1, 2017May 26th, 2020Online Help, Troi Activator Plug-in
Activator Plug-in for FileMaker Pro

Actr_DeleteEvent

This function will remove an event from the memory of the plug-in.

SyntaxFunction badge

Actr_DeleteEvent ( switches ; eventID )

Parameters

switches determines which information is to be deleted
eventID (optional) the event to delete

Switches

switches can be one of this:

-DeleteLastTriggered delete the event that was last triggered
-DeleteAllTriggeredEvents delete all triggered events
-DeleteAllEvents delete all events
-DeleteByID delete the event specified in the next parameter

Returned Result

Data type returned

Error code

Result

If successful it returns 0. If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:

0 no error
$$-50 paramErr check if your parameters are correct
$$-41 memFullErr not enough memory

Other errors may be returned.

Originated in

Activator Plug-in 1.2

Compatibility

FileMaker Pro 15 to 19

Considerations

You can also delete events when you are retrieving data from the event. See the function Actr_GetEventInfo for this.

Example

Set Field [ result ; Actr_DeleteEvent ( "-DeleteAllTriggeredEvents" ; ) ]

This command will remove all triggered events.

Example 2

We assume that in your FileMaker file the following fields are defined:

gErrorCode		Global, text
gEventID		Global, number

gEventID contains an eventID. Add the following script step to your Trigger script:

Set Field [ gErrorCode ; Actr_DeleteEvent ( "-DeleteByID" ;  gEventID ) ]

This will remove the event with the same EventID as in field gEventID from the memory of the plug-in.

Related functionsFunction badge

Actr_GetEventInfo
Actr_ScheduleEvent

Related script stepScript step badge

Delete Script Trigger

Related topics

Activator Plug-in online help (overview)


Online Help Page for Activator Plug-in for 15 to 19 –> Actr_DeleteEvent (actrp4611) 2020-0526 20:04:58