ApiApp().ClearTextOutput

Clears the text output FIFO stack.

Description

This method clears out the text output 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 text output messages.

Example Usage (C#)


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

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().ClearVoiceOutput
  • ApiApp().ClearDiagOutput
  • ApiApp().DisableTextOutput
  • ApiApp().SetTextOutput
  • ApiApp().GetTextOutput