ALM Custom Test Type Developer Guide (12.50 and later)
is_host_ready Method
The reason the host is not ready.
Checks if the testing tool application can be run.
Remarks
Before test execution, the ALM client uses this method to ask the remote agent to ensure that the designated testing host is available and ready to run the test.
Syntax
int is_host_ready( 
   ref string descr
)

Parameters

descr
The reason the host is not ready.

Return Value

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