oaUnitAbort()

The function sets the aborted flag for a test case.

Synopsis

int oaUnitAbort(string TC_ID, [anytype userTcData]);

Parameter


Parameters	Meaning
TC ID	The test ID. Each test case must contain a test ID.
userTcData	The optional user data that is set for the test case.

Return Value

The error code. In case of wrong or missing parameters, the function returns -1 or -2. If the "Aborted" flag was set, the function returns 1.

Error

The function returns the error code.

Description

The CTRL OA Unit CTRL extension contains a set of functions that can be used for testing purposes. The function sets the aborted flag for a test case.

Example

The example sets the aborted flag for a test case. For the first test case no user data is used. For the second test case user data is used.

main()
{
  oaUnitAbort("THIS-IS-MY-FIRST-ABORT-TEST-CASE"); //Test case without user data
  oaUnitAbort("THIS-IS-MY-SECOND-ABORT-TEST-CASE", "Since the test precondition failed");
  /*Test case with user data */
}

Assignment

CTRL OA Unit DLL

Availability

CTRL