envRegLoadDumpTrigger
envRegLoadDumpTrigger(
?tool t_toolName
?loadFunc s_loadFunc
?dumpFunc s_dumpFunc
?preDumpFunc s_preDumpFunc
)
=> t / nil
Description
Registers the trigger function to be called when a tool’s environment variables are loaded or saved to a file. Both the load and dump trigger functions are called after the load or dump of the environment variables, respectively. The preDump trigger is called just before the dump occurs. The dump trigger can be used to update the defValues of forms when a saving of defaults is performed.
Arguments
|
?tool t_toolName
|
The name of the tool for which the triggers should be called.
To set the trigger for all tools at once, use ALL for the t_toolName.
When you specify the ALL option, the ?loadFunc, ?dumpFunc, and ?preDumpFunc argument(s) must accept a single argument t_toolName that was triggered by load or dump. If the user-defined function is generic, and does not vary according to the specific t_toolName value, it is recommended to make the argument as optional. Therefore, the function could be used with either the ALL option or with the specified t_toolName.
Example 1:
procedure( myLoadFunc( @optional tool ) ... ) ; optional single argument, compatible with either “ALL” or a specific t_toolName specified.
Example 2:
procedure( myLoadFunc( tool ) ... ) ; mandatory single argument, compatible only when the “ALL” option is used.
|
|
?loadFunc s_loadFunc
|
|
|
The function to be called after the tool’s environment variables are loaded.
|
|
?dumpFunc s_dumpFunc
|
|
|
The function to be called after the tool’s environment variables are saved to a file.
|
|
?preDumpFunc s_preDumpFunc
|
|
|
The function to be called before any values are stored for the tool.
|
Values Returned
|
t
|
The trigger functions were registered.
|
|
nil
|
There was an error.
|
Related Topics
Cdsenv Editor Functions
Return to top
