TlsSetValue

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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.

BOOL
TlsSetValue(
DWORD
dwTlsIndex
,
LPVOID
lpTlsValue
);

Parameters

dwTlsIndex

[in] Specifies a TLS index that was allocated by the TlsAllocfunction.

lpTlsValue

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

Return Values

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

Remarks

TLS indexes are typically allocated by the TlsAllocfunction during process or DLL initialization. Once 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 TlsSetValueto store a value in its slot. The thread specifies the same index in a subsequent call to TlsGetValueto retrieve the stored value.

TlsSetValueand TlsGetValuewere implemented with speed as the primary goal. These functions perform minimal parameter validation and error checking. In particular, this function succeeds if dwTlsIndexis in the range 0 through (TLS_MINIMUM_AVAILABLE – 1). It is up to the programmer to ensure that the index is valid.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winbase.h		Coremain.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.