XML Definition

Native Functions are defined in an XML Schema file which is located at “cgi_ctudio_connector/schema/NativeFunction.xsd”. This file can be used to validate xml files and with some editors (e.g. Visual-Studio) and provide code-completion when writing the XML file.

NativeFunctionDefinition-Element

Root Element. List of Function types.

Attributes:
None

 Children:

Argument Occurrence Description Function 0 - * A native function definition

Function-Element

Definition of a native Function. 

Attributes:

Argument Required Description name Yes Name of the function. uid Yes Unique Id of function. has_result Yes Indicates if function has a result. If set, the function needs to return a bool value and can be called for checking events. In this case an event is triggered if the function returns true and all conditions are valid. description No Description of the function.

Children:

Argument Occurrence Description Argument 0 - * Argument of the function

Argument-Element

Definition of an argument of the function.

Attributes:

Argument Required Description name Yes Name of the argument. uid Yes Unique Id of argument. type Yes Type of the argument. This can be any basic or complex type if intended to be used for dynamic input/output. For static values any type is supported. description No Description of the argument. is_output No If set, this argument is passed as a reference with the intend to use it as an output value or in a condition.

Children:
None

---