ApiApp().GetTextOutput

Returns the first (FIFO) string in the text output object.

Description

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

Example Usage (C#)


string text = _core.ApiApp().GetTextOutput();

Parameters

None.

Returns

The string value representing the text output, null is returned if disabled or empty.

See Also

  • ApiApp().GetVoiceOutput
  • ApiApp().GetDiagOutput
  • ApiApp().DisableTextOutput
  • ApiApp().SetTextOutput
  • ApiApp().ClearTextOutput

ApiApp() Functions