An NDoc Documented Class Library

HostIntegratorSession.WaitForStringRelCursor Method 

Waits for the presence of a string at a screen location relative to the current terminal screen cursor.

public virtual void WaitForStringRelCursor(
   string str,
   int rowOffset,
   int columnOffset,
   int timeout
);

Parameters

str
Specifies the string to wait for.
rowOffset
Specifies the starting screen row for the string relative to current cursor row.
columnOffset
Specifies the starting screen column for the string relative to current cursor column.
timeout
Specifies a timeout period (in seconds). An exception is thrown if the timeout period elapses before the specified string appears at the specified screen location.

Remarks

Waits for the presence of a string at a screen location relative to the current terminal screen cursor.

Exceptions

Exception TypeCondition
HostIntegratorConnectorExceptionThrown if client is not connected
HostIntegratorConnectorExceptionThrown an argument is invalid
HostIntegratorServerExceptionThrown if the event times out
HostIntegratorConnectorExceptionThrown an argument is invalid

See Also

HostIntegratorSession Class | WRQ.Verastream.HostIntegrator Namespace