sysConnectUserData()

The function allows to connect to specific system events.

Synopsis

int sysConnectUserData([class object,] string|function_ptr work, <any> userData, string event])

Parameters

Parameter Description
object Class in which the work function is located. Only necessary if sysConnect function is called from outside of the class.
work Work function that is called in case of the event being triggered
userData Additional user data to be passed to the function.
event Event on which should be connected

Return value

Returns 0, in case of an error -1 is returned.

Errors

missing/incorrect arguments

Description

The function allows to connect to specific system events and trigger a user defined callback function.

Following events are currently available:

  • "exitRequested"(only in the CTRL Manager)

  • "dpCreated", "dpDeleted", "dpRenamed"

  • "dpTypeCreated", "dpTypeDeleted", "dpTypeChanged"

  • "redu"

  • "dist"

  • "dpAlias"

  • "dpDescription"

  • "dpFormatUnit"

A detailed description of these events can be found inside of the sysConnect() documentation.

For this function the parameters of the sysConnectUserData() are extended by adding the userData Parameter as second parameter to the callback function.

Assignment

Miscellaneous functions

Availability

UI, CTRL