This documentation is archived and is not being maintained.

SortedList.Synchronized Method

Returns a synchronized (thread-safe) wrapper for a SortedList object.

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

<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization := True)> _
Public Shared Function Synchronized ( _
	list As SortedList _
) As SortedList
Dim list As SortedList 
Dim returnValue As SortedList 

returnValue = SortedList.Synchronized(list)


Type: System.Collections.SortedList

The SortedList object to synchronize.

Return Value

Type: System.Collections.SortedList
A synchronized (thread-safe) wrapper for the SortedList object.


list is Nothing.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

To guarantee the thread safety of a SortedList object, all operations must be done through this wrapper only.

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 property during the entire enumeration.

Dim myCollection As New SortedList()
 Dim item As Object
 SyncLock myCollection.SyncRoot
  For Each item In myCollection
  ' Insert your code here.
  Next item
 End SyncLock

This method is an O(1) operation.

The following code example shows how to synchronize a SortedList object, determine whether a SortedList is synchronized, and use a synchronized SortedList.

Imports System
Imports System.Collections
Imports Microsoft.VisualBasic

Public Class SamplesSortedList

    Public Shared Sub Main()

        ' Creates and initializes a new SortedList. 
        Dim mySL As New SortedList()
        mySL.Add(2, "two")
        mySL.Add(3, "three")
        mySL.Add(1, "one")
        mySL.Add(0, "zero")
        mySL.Add(4, "four")

        ' Creates a synchronized wrapper around the SortedList. 
        Dim mySyncdSL As SortedList = SortedList.Synchronized(mySL)

        ' Displays the sychronization status of both SortedLists. 
        Dim msg As String 
        If mySL.IsSynchronized Then
            msg = "synchronized" 
            msg = "not synchronized" 
        End If
        Console.WriteLine("mySL is {0}.", msg)
        If mySyncdSL.IsSynchronized Then
            msg = "synchronized" 
            msg = "not synchronized" 
        End If
        Console.WriteLine("mySyncdSL is {0}.", msg)        
    End Sub 
End Class 

' This code produces the following output. 

' mySL is not synchronized. 
' mySyncdSL is synchronized.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0