TlsSetValue

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function stores a value in the calling thread's thread local storage (TLS) slot for a specified TLS index. Each thread of a process has its own slot for each TLS index.

Syntax

BOOL TlsSetValue(
  DWORD dwTlsIndex,
  LPVOID lpTlsValue
);

Parameters

• dwTlsIndex
  [in] Specifies a TLS index that was allocated by the TlsAlloc function.

• lpTlsValue
  [in] Pointer to the value to be stored in the calling thread's TLS slot specified by dwTlsIndex.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

TLS indexes are typically allocated by the TlsAlloc function during process or DLL initialization. When allocated, each thread of the process can use a TLS index to access its own TLS storage slot for that index.

The storage slot for each thread is initialized to NULL.

A thread specifies a TLS index in a call to TlsSetValue to store a value in its slot. The thread specifies the same index in a subsequent call to TlsGetValue to retrieve the stored value.

The primary goal of TlsSetValue and TlsGetValue is speed. These functions perform minimal parameter validation and error checking. In particular, this function succeeds if dwTlsIndex is in the range zero through (TLS_MINIMUM_AVAILABLE – 1). You must ensure that the index is valid.

Requirements

See Also

Reference

Process and Thread Functions
TlsAlloc
TlsFree
TlsGetValue