ApiApp().ClearApplicationMessage

Clears the application message FIFO stack.

Description

This method clears out the application message FIFO stack. Either an API call from the application or a call from script may be used to invoke this method as a housecleaning tool, in order to clear out any unused or otherwise undesirable application messages.

Example Usage (C#)


bool cleared = _core.ApiApp().ClearApplicationMessage();

Parameters

None.

Returns

The boolean success or failure of the operation. If the FIFO stack was already empty, then false is returned.

See Also

  • ApiApp().DisableApplicationMessage
  • ApiApp().SetApplicationMessage
  • ApiApp().GetApplicationMessage

ApiApp() Functions