This documentation is archived and is not being maintained.

RouteCollection.GetWriteLock Method

Provides an object for managing thread safety when you add or remove elements in the collection.

Namespace:  System.Web.Routing
Assembly:  System.Web.Routing (in System.Web.Routing.dll)

'Declaration
Public Function GetWriteLock As IDisposable
'Usage
Dim instance As RouteCollection 
Dim returnValue As IDisposable 

returnValue = instance.GetWriteLock()

Return Value

Type: System.IDisposable
An object that manages thread safety.

The recommended approach for defining routes in an ASP.NET application is to add the routes to the Routes property in an event handler for the Application_Start event in the Global.asax file. For more information, see RouteCollection.

If you have to add a route when the application is running, you use the GetWriteLock method to guarantee thread safety. The write lock on the route collection is released when the IDisposable object that is returned by this method is disposed.

The following example shows how to use the GetWriteLock method when you add a route while the application is running.

Using RouteTable.Routes.GetWriteLock()
    Dim urlPattern As String 
    Dim newRoute As Route

    urlPattern = "{action}/{id}"
    newRoute = New Route(urlPattern, New ReportRouteHandler)
    RouteTable.Routes.Add(newRoute)
End Using

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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 SP1
Show: