TryEnter Method (Object, TimeSpan)

Monitor.TryEnter Method (Object, TimeSpan)

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object.

Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)

'Declaration
Public Shared Function TryEnter ( _
	obj As Object, _
	timeout As TimeSpan _
) As Boolean
'Usage
Dim obj As Object
Dim timeout As TimeSpan
Dim returnValue As Boolean

returnValue = Monitor.TryEnter(obj, timeout)
public static boolean TryEnter (
	Object obj, 
	TimeSpan timeout
)
public static function TryEnter (
	obj : Object, 
	timeout : TimeSpan
) : boolean

Parameters

obj

The object on which to acquire the lock.

timeout

A TimeSpan representing the amount of time to wait for the lock. A value of –1 millisecond specifies an infinite wait.

Return Value

true if the current thread acquires the lock without blocking; otherwise, false.

Exception typeCondition

ArgumentNullException

The obj parameter is a null reference (Nothing in Visual Basic).

ArgumentException

The obj parameter is a value type.

ArgumentOutOfRangeException

The value of timeout in milliseconds is negative and is not equal to Infinite (–1 millisecond), or is greater than MaxValue.

If the value of the timeout parameter converted to milliseconds equals –1, this method is equivalent to Enter. If the value of timeout equals 0, this method is equivalent to TryEnter.

NoteNote

Use Monitor to lock objects (that is, reference types), not value types. For details, see Enter and the conceptual topic Monitors.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2016 Microsoft