Actr_Control (function reference)

Activator Plug-in for FileMaker Pro

Actr_Control

Controls the triggering of the plug-in. You can disable and enable local triggering of the plug-in. This allows you to change the contents of a field which is validated by triggering a script.

SyntaxFunction badge

Actr_Control ( switches ; password )

Parameters

switchesthese determine how the function works. You can disable or enable all functions
passwordthe password to be used

Switches

switches can be one of the following:

-DisableLocalTriggersdisable triggering of scripts on this computer and also the scheduling of new triggers
-EnableLocalTriggersenable triggering of scripts on this computer and also the scheduling of new triggers
-GetLocalTriggerStatusget the status of the local triggering: 1 is on, 0 is off

Returned Result

Data type returned

Error code

Result

The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors. Returned error codes can be:

0no error
$$-4217pwdAlreadySetpassword already set (enable first)
$$-4218alreadyEnabledfunctions are already enabled
$$-4219pwdWronggiven password was wrong

Other errors may be returned.

Originated in

Activator Plug-in 1.2

Compatibility

FileMaker Pro 12 to 16

Considerations

When you call Actr_ScheduleEvent when triggering is disabled an error code of $$-4220 is returned.

When you disable triggering also the scheduling of new local trigger events is disabled until restart of FileMaker. Other users can still trigger scripts on their computer and you can also send a remote event to another computer.

Example

Set Field [ result ; Actr_Control ( "-DisableLocalTriggers" ; "secret password" ) ]

This will disable the trigger functions of the plug-in on this computer.

Example 2

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

gErrorCode		Global, number	
gPassword		Global, text

gPassword should contain a password, for example “rapunsel”. Add the following steps to a script:

Set Field [ gErrorCode ; Actr_Control ( "-DisableLocalTriggers" ; gPassword ) ]
#... do for example a Replace function  on a script validated function...
Replace Contents [ ValidateField ; newValue ]
Set Field [ gErrorCode ; Actr_Control ( "-EnableLocalTriggers" ; gPassword ) ]

This will first disable the plug-in’s triggers. Then you can change the values. The last step reactivates triggering.

Related functionFunction badge

Actr_ScheduleEvent

Related topics

Activator Plug-in online help (overview)


Online Help Page for Activator Plug-in for 12 to 16 –> Actr_Control (actrp4610) 2017-0822 12:49:11