TlsFree

This function releases a thread local storage (TLS) index, making it available for reuse.

At a Glance

Header file:	Winbase.h
Windows CE versions:	1.0 and later

Syntax

BOOL TlsFree(DWORD dwTlsIndex);

Parameters

dwTlsIndex

Specifies a TLS index that was allocated by the TlsAlloc function.

Return Values

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

Remarks

If the threads of the process have allocated dynamic storage and used the TLS index to store pointers to this storage, they should free the storage before calling TlsFree. The TlsFree function does not free any dynamic storage that has been associated with the TLS index. It is expected that DLLs call this function (if at all) only during their process detach routine.

For a brief discussion of typical uses of the TLS functions, see the Remarks section of the TlsAlloc function.