TPF_TC_IGNORE: Notify automated test framework of skipped test case

This C/C++ macro indicates that the current test case should not be counted as either passed or failed.

Last updated

Added for PUT15.

Format

maketpf_env += idevops
#include <tpf/c_devops.h>
void TPF_TC_IGNORE(printfFormatting);
printfFormatting
The format specification and associated optional parameters that adhere to the syntax requirements for the printf standard C function.

Normal return

None.

Error return

If a test case handle is not set, a DE1045 system error is issued and the ECB exits.

Programming considerations

  • Do not use this macro in production applications.
  • You can issue this macro from any ECB that participates in the text case.
  • If a test case was marked as failed by using the TPF_TC_ERROR macro, this macro does not change the state of the test case and the test case remains marked as failed.
  • A new line character (\n) is automatically appended to the end of the message text.

Examples

The following example indicates that the current test case should be ignored by the automated test framework and not counted as either passed or failed.

//If the system is not in NORM state, this test case must be ignored
if (!isSystemInNorm()) {
   TPF_TC_IGNORE("System is not in NORM state"); 
   return;
}