Win32 API 日本語リファレンス
ホームSystem.Threading › TlsFree

TlsFree

関数
確保したTLSインデックスを解放する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL TlsFree(
    DWORD dwTlsIndex
);

パラメーター

名前方向説明
dwTlsIndexDWORDinTlsAlloc 関数によって割り当てられた TLS インデックス。

戻り値の型: BOOL

公式ドキュメント

スレッドローカルストレージ (TLS) インデックスを解放し、再利用できるようにします。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

Windows Phone 8.1: この関数は、Windows Phone 8.1 以降の Windows Phone ストアアプリでサポートされます。Windows Phone ストアアプリがこの関数を呼び出すと、FlsFree へのインライン呼び出しに置き換えられます。関数のドキュメントについては FlsFree を参照してください。

Windows 8.1Windows Server 2012 R2、および Windows 10, version 1507: この関数は、Windows 8.1、Windows Server 2012 R2、および Windows 10, version 1507 の Windows ストアアプリでサポートされます。Windows ストアアプリがこの関数を呼び出すと、FlsFree へのインライン呼び出しに置き換えられます。関数のドキュメントについては FlsFree を参照してください。

Windows 10, version 1511 および Windows 10, version 1607: この関数は、ユニバーサル Windows プラットフォーム (UWP) アプリで完全にサポートされ、FlsFree へのインライン呼び出しに置き換えられることはなくなりました。

プロセスのスレッドがメモリを割り当て、そのメモリへのポインターを TLS スロットに格納している場合は、 TlsFree を呼び出す前にそのメモリを解放する必要があります。TlsFree 関数は、TLS インデックスに関連付けられた TLS スロットにアドレスが格納されているメモリブロックを解放しません。DLL がこの関数を呼び出す場合 (呼び出すとすれば)、DLL_PROCESS_DETACH の間にのみ呼び出すことが想定されています。

詳細については、スレッドローカルストレージを参照してください。

例については、Using Thread Local Storage または Using Thread Local Storage in a Dynamic-Link Library を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL TlsFree(
    DWORD dwTlsIndex
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TlsFree(
    uint dwTlsIndex   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TlsFree(
    dwTlsIndex As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwTlsIndex : DWORD
Declare PtrSafe Function TlsFree Lib "kernel32" ( _
    ByVal dwTlsIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TlsFree = ctypes.windll.kernel32.TlsFree
TlsFree.restype = wintypes.BOOL
TlsFree.argtypes = [
    wintypes.DWORD,  # dwTlsIndex : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
TlsFree = Fiddle::Function.new(
  lib['TlsFree'],
  [
    -Fiddle::TYPE_INT,  # dwTlsIndex : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn TlsFree(
        dwTlsIndex: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool TlsFree(uint dwTlsIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TlsFree' -Namespace Win32 -PassThru
# $api::TlsFree(dwTlsIndex)
#uselib "KERNEL32.dll"
#func global TlsFree "TlsFree" sptr
; TlsFree dwTlsIndex   ; 戻り値は stat
; dwTlsIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global TlsFree "TlsFree" int
; res = TlsFree(dwTlsIndex)
; dwTlsIndex : DWORD -> "int"
; BOOL TlsFree(DWORD dwTlsIndex)
#uselib "KERNEL32.dll"
#cfunc global TlsFree "TlsFree" int
; res = TlsFree(dwTlsIndex)
; dwTlsIndex : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procTlsFree = kernel32.NewProc("TlsFree")
)

// dwTlsIndex (DWORD)
r1, _, err := procTlsFree.Call(
	uintptr(dwTlsIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function TlsFree(
  dwTlsIndex: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'TlsFree';
result := DllCall("KERNEL32\TlsFree"
    , "UInt", dwTlsIndex   ; DWORD
    , "Int")   ; return: BOOL
●TlsFree(dwTlsIndex) = DLL("KERNEL32.dll", "bool TlsFree(dword)")
# 呼び出し: TlsFree(dwTlsIndex)
# dwTlsIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn TlsFree(
    dwTlsIndex: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc TlsFree(
    dwTlsIndex: uint32  # DWORD
): int32 {.importc: "TlsFree", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int TlsFree(
    uint dwTlsIndex   // DWORD
);
ccall((:TlsFree, "KERNEL32.dll"), stdcall, Int32,
      (UInt32,),
      dwTlsIndex)
# dwTlsIndex : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TlsFree(
    uint32_t dwTlsIndex);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.TlsFree(dwTlsIndex)
-- dwTlsIndex : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const TlsFree = lib.func('__stdcall', 'TlsFree', 'int32_t', ['uint32_t']);
// TlsFree(dwTlsIndex)
// dwTlsIndex : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  TlsFree: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.TlsFree(dwTlsIndex)
// dwTlsIndex : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TlsFree(
    uint32_t dwTlsIndex);
C, "KERNEL32.dll");
// $ffi->TlsFree(dwTlsIndex);
// dwTlsIndex : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean TlsFree(
        int dwTlsIndex   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun TlsFree = TlsFree(
    dwTlsIndex : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TlsFreeNative = Int32 Function(Uint32);
typedef TlsFreeDart = int Function(int);
final TlsFree = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<TlsFreeNative, TlsFreeDart>('TlsFree');
// dwTlsIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TlsFree(
  dwTlsIndex: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'TlsFree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TlsFree"
  c_TlsFree :: Word32 -> IO CInt
-- dwTlsIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tlsfree =
  foreign "TlsFree"
    (uint32_t @-> returning int32_t)
(* dwTlsIndex : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("TlsFree" tls-free :convention :stdcall) :int32
  (dw-tls-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TlsFree = Win32::API::More->new('KERNEL32',
    'BOOL TlsFree(DWORD dwTlsIndex)');
# my $ret = $TlsFree->Call($dwTlsIndex);
# dwTlsIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。