ApiApp().GetApplicationMessage

Returns the first (FIFO) string in the application message object.

Description

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

Example Usage (C#)


string appMessage = _core.ApiApp().GetApplicationMessage();

Parameters

None.

Returns

The string value representing the message for the application, null is returned if disabled or empty.

See Also

  • ApiApp().DisableApplicationMessage
  • ApiApp().SetApplicationMessage
  • ApiApp().ClearApplicationMessage

ApiApp() Functions