TlsFree

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

Syntax

Copy
BOOL TlsFree(
    DWORD TlsIndex
);

Parameters

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.

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 RTDLLs 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 Comments section of TlsAlloc.

Requirements

Minimum supported version Header Library

eRTOS 1.0 SDK

windows.h rtkrnl.lib

See Also: