Knowledge Base

  1. Home
  2. Knowledge Base
  3. Technical Support
  4. Script Commands
  5. rtcFailAll()

rtcFailAll()

Instructs the probe to fail gracefully and force failure on all other probes running the script, providing a verbose fail reason.

rtcFailAll() can be used to fail a running script at a given point in time and provide a textual explanation for the failure reason. This can be useful in functional tests where certain conditions are saught after.

This command will also cause all other probes to stop executing their script and fail (without collecting logs).

Arguments:

NameTypeDescription
reasonstringThe failure reason to use.

Notes:

  • The reason provided in the string will be used as the failure reason for the probe in the test result
  • Other probes will be forced to fail, and not collect logs
  • See also rtcWarning() and rtcFail()

Was this article helpful?

Related Articles

Leave a Reply 0 comments

Leave a Reply: