Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual - Manual (Page 190)

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
ISASAPISrvs 190
GetGenerationStatus
HRESULT GetGenerationStatus(
[out]BOOL* pbIsGenerating,
[out]BOOL* pbIsBreaked,
[out]BOOL* pbIsConnected);
Inputs
BOOL* pbIsGenerating:
a Boolean pointer to return generation status. If the
pointer value after call is TRUE, the generation engine is in generating state. Otherwise, it
means generation complete.
BOOL* pbIsBreaked:
a Boolean pointer to return generation pause status. If the
pointer value after call is TRUE, the generation engine is breaking because of a “pause”
command in the script.
BOOL* pbIsConnected:
a Boolean pointer to return link status. If the pointer value
after call is TRUE, the connection between the Trainer module and the DUT is ok and they are
communicating.
Return Value
Remark
This method returns the generation status. You can call this method as a polling method in
specified time intervals using timers or threads.
NOTE: Do not call this method when any engine Start/Run method is in progress. The API should
wait until Start/Run completes before calling this method.
See Also
StartGeneration