Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SyncRoot Property
Collapse the table of content
Expand the table of content

Stack.SyncRoot Property

Gets an object that can be used to synchronize access to the Stack.

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

'Declaration
Public Overridable ReadOnly Property SyncRoot As Object

Property Value

Type: System.Object
An Object that can be used to synchronize access to the Stack.

Implements

ICollection.SyncRoot

To create a synchronized version of the Stack, use the Synchronized method. However, derived classes can provide their own synchronized version of the Stack using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot of the Stack, not directly on the Stack. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the Stack object.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

The following code example shows how to lock the collection using the SyncRoot during the entire enumeration.

Dim myCollection As New Stack()

SyncLock myCollection.SyncRoot
    For Each item As Object In myCollection
        ' Insert your code here. 
    Next item
End SyncLock

Retrieving the value of this property is an O(1) operation.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft