ApiApp().SetApplicationMessage

Pushes the message output onto the application message object’s FIFO stack.

Description

If the application message output has been enabled (default), via the application, this method pushes the output of a string via the application message stack. Either the application or a script may poll and fetch application messages via the getApplicationMessage method. Note that the application, not the core, is responsible for handling the fetch and subsequent operations on such messages.

Example Usage (C#)


bool success = _core.ApiApp().SetApplicationMessage(“Close Main Form”);

Parameters

string

output

The string representing the message to be sent to the application.

Returns

The boolean success or failure of the operation.

See Also

  • ApiApp().DisableApplicationMessage
  • ApiApp().GetApplicationMessage
  • ApiApp().ClearApplicationMessage

ApiApp() Functions