Share via

  • Article

Monitor.TryEnter Method (Object, TimeSpan)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

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

public static bool TryEnter(
    Object obj,
    TimeSpan timeout
)

Parameters

  • obj
    Type: System.Object
    The object on which to acquire the lock.
  • timeout
    Type: System.TimeSpan
    A TimeSpan representing the amount of time to wait for the lock. A value of –1 millisecond specifies an infinite wait.

Return Value

Type: System.Boolean
true if the current thread acquires the lock without blocking; otherwise, false.

Exceptions

Exception Condition
ArgumentNullException

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

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

Remarks

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.

Version Notes

Silverlight for Windows Phone Silverlight for Windows Phone

When a user navigates away from a Windows Phone application, the application is typically put into a dormant state. When the user returns to a dormant application, the application automatically resumes. If the application is put into a dormant state while this API is being used, the API will not complete as expected. Applications should be designed to handle this possibility. For more information about the Windows Phone execution model, see Execution Model for Windows Phone.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.