ApiApp().SetTextOutput

Pushes the output onto the text output object’s FIFO stack.

Description

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

Example Usage (C#)


bool success = _core.ApiApp().SetTextOutput(“Shall we continue in text only mode?”);

Parameters

string

output

The string for text output.

Returns

The boolean success or failure of the operation.

See Also

  • ApiApp().SetSocketOutput
  • ApiApp().SetVoiceOutput
  • ApiApp().SetDiagOutput
  • ApiApp().DisableTextOutput
  • ApiApp().GetTextOutput
  • ApiApp().ClearTextOutput

ApiApp() Functions