ApiApp().GetDiagOutput

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

Description

If the diagnostic output has been enabled (default), via the application, this method fetches the first string from the diagnostic output stack. Either the application or a script may poll and fetch diagnostic 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 diag = _core.ApiApp().GetDiagOutput();

Parameters

None.

Returns

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

See Also

  • ApiApp().GetVoiceOutput
  • ApiApp().GetTextOutput
  • ApiApp().DisableDiagOutput
  • ApiApp().SetDiagOutput
  • ApiApp().ClearDiagOutput

ApiApp() Functions