ALM Custom Test Type Developer Guide (12.50 and later)
get_status Method
The testing tool’s current status.
One of:
busy
The testing tool is currently running another test.
end_of_test
The testing tool has reached the end of the current test.
failed
The testing tool has failed.
init
The testing tool is in its initialization stage.
logical_running
The testing tool is running the test.
paused
The testing tool has paused execution of the current test.
ready
The testing tool is ready to run the test.
stopped
The testing tool has stopped execution of the current test.
test_passed
The test has been successfully completed.
test_failed
The test failed.
retry
You cannot execute the test on the current host. Try to execute the test on another host from the attached host group.
Gets the current status of the testing tool.
Remarks
During test execution, ALM checks the status of the testing tool and displays this information. This enables the tester to monitor the test’s progress at each stage of the run.
Syntax
int get_status( 
   ref string descr,
   ref string status
)

Parameters

descr
The testing tool’s current status.
status
One of:
busy
The testing tool is currently running another test.
end_of_test
The testing tool has reached the end of the current test.
failed
The testing tool has failed.
init
The testing tool is in its initialization stage.
logical_running
The testing tool is running the test.
paused
The testing tool has paused execution of the current test.
ready
The testing tool is ready to run the test.
stopped
The testing tool has stopped execution of the current test.
test_passed
The test has been successfully completed.
test_failed
The test failed.
retry
You cannot execute the test on the current host. Try to execute the test on another host from the attached host group.

Return Value

0 if the testing tool and host are ready to run tests, otherwise an error code.