Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleDescription

Invokes a function on the gateway. It will return the return value of the function, or throw an exception if something went wrong calling that function.

Warning

This function has been restricted from the user manual because it is potentially harmful. It may be removed from the software completely.

Panel
titleSyntax

system.util. invokeGateway(function)

  • Parameters

String function  - The function name.

PyObjects  args  Any number of args to send to the function in a list.

  • Returns

Object return  - The return from the function that was passed in.

  • Scope

All

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
#This will take the text written into the text area, and save it to a file on the gateway.
 
data = event.source.parent.getComponent("Text Area").text
system.util.invokeGateway("system.file.writeFile", ["C:\\MyFile.txt", data])