 |
Delete Script Trigger |
This function will remove a trigger event from the memory of the plug-in.
Syntax
Delete Script Trigger [ Select ; Result (error) ; Action ; EventID ]
Options
| Select entire contents | replaces the entire contents of a field with the result. If not checked the result replaces the currently selected portion of the field |
| Result (error) | an error code |
| Action | choose "Delete last triggered" to delete the event that was last triggered, "Delete all triggered" to delete all triggered events, "Delete all" to delete all events or "Delete by ID" to delete the event specified in the next parameter |
| EventID | (optional) the event to delete |
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 4.5
Compatibility
FileMaker Pro 17 to 2023
Considerations
You can also delete events when you are retrieving data from the event. See the function Actr_GetEventInfo for this.
Example
Delete Script Trigger [ Select ; Result ; Delete all triggered ]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, numbergEventID contains an eventID. Add the following script step to your Trigger script:
Delete Script Trigger [ Select ; gErrorCode ; Delete by ID ; gEventID ]This will remove the event with the same EventID as in field gEventID from the memory of the plug-in.
Used in example file
ScheduleTriggers.fmp12
Related script step
| Schedule Script Trigger |
Related functions
| Actr_DeleteEvent |
| Actr_GetEventInfo |
Related topics
Activator Plug-in online help (overview)
