envRegSetTrigger
envRegSetTrigger(
t_tool
s_triggerFunc
)
=> t / nil
Description
Registers a set trigger function for a tool. This trigger is called after an environment variable is set.
Arguments
|
t_tool
|
The name of the tool for which you want to register a set trigger function. If a set trigger function has already been set for the tool, this function returns nil.
|
|
s_triggerFunc
|
The trigger function to be called after an environment variable is set. The trigger function is passed the variable that was set and its old and new values. The trigger function has the following format:
setTrigger([toolPartition] t_varName g_oldValue g_newValue)
where toolPartition is the name of the partition that the variable being set belongs to, else nil.
|
Values Returned
|
t
|
The set trigger function was registered.
|
|
nil
|
There was an error.
|
Related Topics
Cdsenv Editor Functions
Return to top
