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

TlsGetValue

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

シグネチャ

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

void* TlsGetValue(
    DWORD dwTlsIndex
);

パラメーター

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

戻り値の型: void*

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は指定されたインデックスに関連付けられた呼び出し元スレッドの TLS スロットに格納されている値です。dwTlsIndexTlsAlloc の呼び出しが成功して割り当てられた有効なインデックスであれば、この関数は常に成功します。

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

TLS スロットに格納されたデータは、初期値のままであるため、あるいはスレッドが TlsSetValue 関数を 0 を指定して呼び出したために、値が 0 になることがあります。したがって、戻り値が 0 の場合は、関数が失敗したと判断する前に、GetLastErrorERROR_SUCCESS を返すかどうかを確認する必要があります。GetLastErrorERROR_SUCCESS を返す場合、関数は成功しており、TLS スロットに格納されているデータは 0 です。そうでない場合、関数は失敗しています。

失敗を示す値を返す関数は、失敗時に SetLastError を呼び出します。これらの関数は通常、成功時には SetLastError を呼び出しません。TlsGetValue 関数はこの一般的な規則の例外です。TlsGetValue 関数は成功時に SetLastError を呼び出してスレッドの最終エラーをクリアします。これにより、0 の値をエラーなく取得できたことを確認できます。

解説(Remarks)

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

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

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

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

TlsGetValue は常にスレッドの最終エラーを設定します。場合によっては、アプリケーション (malloc をサポートするカスタム ヒープを持つものなど) は、TlsGetValue を呼び出す前に GetLastError を呼び出してスレッドの最終エラーを保存し (その後 SetLastError で保存したエラーを復元する) 必要があります。残念ながら、これは特定の CPU では無視できないパフォーマンス コストを生じさせる可能性があります。

Windows 11 24H2 以降: TlsGetValue2 関数を使用してください。これは TlsGetValue と同一ですが、スレッドの最終エラーを設定しない点が異なります。TlsGetValue2 を呼び出すアプリケーションでは、TlsGetValue2 が失敗したかどうかを確認するために GetLastError を呼び出すことができないため、有効な値として 0 を使用することは避けるべきです。

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

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

各言語での呼び出し定義

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

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

TlsGetValue = ctypes.windll.kernel32.TlsGetValue
TlsGetValue.restype = ctypes.c_void_p
TlsGetValue.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')
TlsGetValue = Fiddle::Function.new(
  lib['TlsGetValue'],
  [
    -Fiddle::TYPE_INT,  # dwTlsIndex : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn TlsGetValue(
        dwTlsIndex: u32  // DWORD
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr TlsGetValue(uint dwTlsIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TlsGetValue' -Namespace Win32 -PassThru
# $api::TlsGetValue(dwTlsIndex)
#uselib "KERNEL32.dll"
#func global TlsGetValue "TlsGetValue" sptr
; TlsGetValue dwTlsIndex   ; 戻り値は stat
; dwTlsIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global TlsGetValue "TlsGetValue" int
; res = TlsGetValue(dwTlsIndex)
; dwTlsIndex : DWORD -> "int"
; void* TlsGetValue(DWORD dwTlsIndex)
#uselib "KERNEL32.dll"
#cfunc global TlsGetValue "TlsGetValue" int
; res = TlsGetValue(dwTlsIndex)
; dwTlsIndex : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procTlsGetValue = kernel32.NewProc("TlsGetValue")
)

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

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

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

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

let tlsgetvalue =
  foreign "TlsGetValue"
    (uint32_t @-> returning (ptr void))
(* 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 ("TlsGetValue" tls-get-value :convention :stdcall) :pointer
  (dw-tls-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TlsGetValue = Win32::API::More->new('KERNEL32',
    'LPVOID TlsGetValue(DWORD dwTlsIndex)');
# my $ret = $TlsGetValue->Call($dwTlsIndex);
# dwTlsIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API