WaitForUnlock Method

Top  Previous  Next

This method waits until the host system turns to an unlocked state.

 

VB.NET Syntax

 

[Boolean] = tnxxxx.WaitForUnlock ([TimeOut As Integer])

 

C# Syntax

 

[bool] = tnxxxx.WaitForUnlock ([int TimeOut]);

 

The TimeOut parameter is measured in milliseconds.

 

 

Remarks

 

If the host system is in an unlock state this method returns immediately. If the host system is in a lock state, the method waits until a system unlock event arrives (OnSystemUnlock).

The Timeout parameter is optional, assuming the WaitTimeout property value by default. The method returns True if the wait was successful and False if the Timeout period has expired.

If you pass a timeout value in the Timeout parameter of this method, the value of the property WaitTimeout will not have any effect.

 

See also WaitTimeout property and WaitForNewUnlock method.