TlsFree

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

Syntax

BOOL TlsFree(
    [in]    DWORD TlsIndex
);

Parameters

[in] TlsIndex

The TLS index that was allocated by TlsAlloc.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to get extended error information.

Remarks

If the process threads 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 associated with the TLS index. DLLs are expected to 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 TlsAlloc.

Requirements

See Also:

• TlsAlloc
• TlsGetValue
• TlsSetValue