Export (0) Print
Expand All

ThreadLocal(T) Class

Provides thread-local storage of data.

System.Object
  System.Threading.ThreadLocal(T)

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

[<DebuggerDisplayAttribute("IsValueCreated={IsValueCreated}, Value={ValueForDebugDisplay}, Count={ValuesCountForDebugDisplay}")>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)>]
type ThreadLocal<'T> =  
    class 
        interface IDisposable 
    end

Type Parameters

T

Specifies the type of data stored per-thread.

The ThreadLocal(T) type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryThreadLocal(T)()Initializes the ThreadLocal(T) instance.
Public methodThreadLocal(T)(Boolean)Initializes the ThreadLocal(T) instance.
Public methodSupported by Portable Class LibraryThreadLocal(T)(Func(T))Initializes the ThreadLocal(T) instance with the specified valueFactory function.
Public methodThreadLocal(T)(Func(T), Boolean)Initializes the ThreadLocal(T) instance with the specified valueFactory function.
Top

  NameDescription
Public propertySupported by Portable Class LibraryIsValueCreatedGets whether Value is initialized on the current thread.
Public propertySupported by Portable Class LibraryValueGets or sets the value of this instance for the current thread.
Public propertyValuesGets a list for all of the values currently stored by all of the threads that have accessed this instance.
Top

  NameDescription
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the current instance of the ThreadLocal(T) class.
Protected methodSupported by Portable Class LibraryDispose(Boolean)Releases the resources used by this ThreadLocal(T) instance.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeReleases the resources used by this ThreadLocal(T) instance. (Overrides Object.Finalize().)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringCreates and returns a string representation of this instance for the current thread. (Overrides Object.ToString().)
Top

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. 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.

The following example shows how to use ThreadLocal(T):

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

With the exception of Dispose, all public and protected members of ThreadLocal(T) thread-safe and may be used concurrently from multiple threads. The value returned for the Value and IsValueCreated properties is specific for the thread on which the property is accessed.

Show:
© 2015 Microsoft