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

TlsSetValue

関数
指定TLSスロットに値を格納する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL TlsSetValue(
    DWORD dwTlsIndex,
    void* lpTlsValue   // optional
);

パラメーター

名前方向説明
dwTlsIndexDWORDinTlsAlloc 関数によって割り当てられた TLS インデックスです。
lpTlsValuevoid*inoptionalこのインデックスに対応する、呼び出し元スレッドの TLS スロットに格納する値です。

戻り値の型: BOOL

公式ドキュメント

指定された TLS インデックスに対応する、呼び出し元スレッドのスレッドローカルストレージ (TLS) スロットに値を格納します。プロセスの各スレッドは、TLS インデックスごとに独自のスロットを持ちます。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

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

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

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

TLS インデックスは通常、プロセスまたは DLL の初期化時に TlsAlloc 関数によって割り当てられます。TLS インデックスが割り当てられると、そのストレージスロットは NULL に初期化されます。TLS インデックスが割り当てられた後、プロセスの各スレッドはそれを使用して、当該インデックスに対応する自身の TLS スロットにアクセスできます。スレッドは TlsSetValue の呼び出しで TLS インデックスを指定して、自身のスロットに値を格納します。その後、スレッドが TlsGetValue の呼び出しで同じインデックスを指定すると、格納された値を取得できます。

TlsSetValue は速度を最優先に実装されています。この関数は最小限のパラメーター検証とエラーチェックしか行いません。具体的には、dwTlsIndex が 0 から (TLS_MINIMUM_AVAILABLE – 1) の範囲内であれば成功します。TlsGetValue を呼び出す前にインデックスが有効であることを保証するのは、プログラマーの責任です。

例については、スレッドローカルストレージの使用またはダイナミックリンクライブラリでのスレッドローカルストレージの使用を参照してください。

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

各言語での呼び出し定義

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

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

TlsSetValue = ctypes.windll.kernel32.TlsSetValue
TlsSetValue.restype = wintypes.BOOL
TlsSetValue.argtypes = [
    wintypes.DWORD,  # dwTlsIndex : DWORD
    ctypes.POINTER(None),  # lpTlsValue : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
TlsSetValue = Fiddle::Function.new(
  lib['TlsSetValue'],
  [
    -Fiddle::TYPE_INT,  # dwTlsIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpTlsValue : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn TlsSetValue(
        dwTlsIndex: u32,  // DWORD
        lpTlsValue: *mut ()  // void* optional
    ) -> 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 TlsSetValue(uint dwTlsIndex, IntPtr lpTlsValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TlsSetValue' -Namespace Win32 -PassThru
# $api::TlsSetValue(dwTlsIndex, lpTlsValue)
#uselib "KERNEL32.dll"
#func global TlsSetValue "TlsSetValue" sptr, sptr
; TlsSetValue dwTlsIndex, lpTlsValue   ; 戻り値は stat
; dwTlsIndex : DWORD -> "sptr"
; lpTlsValue : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global TlsSetValue "TlsSetValue" int, sptr
; res = TlsSetValue(dwTlsIndex, lpTlsValue)
; dwTlsIndex : DWORD -> "int"
; lpTlsValue : void* optional -> "sptr"
; BOOL TlsSetValue(DWORD dwTlsIndex, void* lpTlsValue)
#uselib "KERNEL32.dll"
#cfunc global TlsSetValue "TlsSetValue" int, intptr
; res = TlsSetValue(dwTlsIndex, lpTlsValue)
; dwTlsIndex : DWORD -> "int"
; lpTlsValue : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procTlsSetValue = kernel32.NewProc("TlsSetValue")
)

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

extern "kernel32" fn TlsSetValue(
    dwTlsIndex: u32, // DWORD
    lpTlsValue: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc TlsSetValue(
    dwTlsIndex: uint32,  # DWORD
    lpTlsValue: pointer  # void* optional
): int32 {.importc: "TlsSetValue", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int TlsSetValue(
    uint dwTlsIndex,   // DWORD
    void* lpTlsValue   // void* optional
);
ccall((:TlsSetValue, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}),
      dwTlsIndex, lpTlsValue)
# dwTlsIndex : DWORD -> UInt32
# lpTlsValue : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TlsSetValue(
    uint32_t dwTlsIndex,
    void* lpTlsValue);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.TlsSetValue(dwTlsIndex, lpTlsValue)
-- dwTlsIndex : DWORD
-- lpTlsValue : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const TlsSetValue = lib.func('__stdcall', 'TlsSetValue', 'int32_t', ['uint32_t', 'void *']);
// TlsSetValue(dwTlsIndex, lpTlsValue)
// dwTlsIndex : DWORD -> 'uint32_t'
// lpTlsValue : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  TlsSetValue: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.TlsSetValue(dwTlsIndex, lpTlsValue)
// dwTlsIndex : DWORD -> "u32"
// lpTlsValue : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TlsSetValue(
    uint32_t dwTlsIndex,
    void* lpTlsValue);
C, "KERNEL32.dll");
// $ffi->TlsSetValue(dwTlsIndex, lpTlsValue);
// dwTlsIndex : DWORD
// lpTlsValue : void* optional
// 構造体/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 TlsSetValue(
        int dwTlsIndex,   // DWORD
        Pointer lpTlsValue   // void* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun TlsSetValue = TlsSetValue(
    dwTlsIndex : UInt32,   # DWORD
    lpTlsValue : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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