TlsAlloc
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
DWORD TlsAlloc(void);パラメーターなし。戻り値: DWORD
公式ドキュメント
スレッドローカルストレージ (TLS) インデックスを割り当てます。各スレッドはこのインデックス用に独自のスロットを受け取るため、プロセス内の任意のスレッドが、その後このインデックスを使用してスレッドに固有の値を格納および取得できます。
戻り値
関数が成功した場合、戻り値は TLS インデックスです。インデックスのスロットはゼロに初期化されます。
関数が失敗した場合、戻り値は TLS_OUT_OF_INDEXES です。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
Windows Phone 8.1: この関数は、Windows Phone 8.1 以降の Windows Phone Store アプリでサポートされています。Windows Phone Store アプリがこの関数を呼び出すと、FlsAlloc へのインライン呼び出しに置き換えられます。関数のドキュメントについては、FlsAlloc を参照してください。
Windows 8.1、Windows Server 2012 R2、および Windows 10, version 1507: この関数は、Windows 8.1、Windows Server 2012 R2、および Windows 10, version 1507 の Windows Store アプリでサポートされています。Windows Store アプリがこの関数を呼び出すと、FlsAlloc へのインライン呼び出しに置き換えられます。関数のドキュメントについては、FlsAlloc を参照してください。
Windows 10, version 1511 および Windows 10, version 1607: この関数はユニバーサル Windows プラットフォーム (UWP) アプリで完全にサポートされており、FlsAlloc へのインライン呼び出しに置き換えられることはなくなりました。
プロセスのスレッドは、その後の TlsFree、TlsSetValue、または TlsGetValue 関数の呼び出しで TLS インデックスを使用できます。TLS インデックスの値は不透明な値として扱う必要があります。ゼロから始まる配列へのインデックスであると仮定しないでください。
TLS インデックスは通常、プロセスまたはダイナミックリンクライブラリ (DLL) の初期化中に割り当てられます。TLS インデックスが割り当てられると、その格納スロットは NULL に初期化されます。TLS インデックスが割り当てられると、プロセスの各スレッドはそれを使用して独自の TLS 格納スロットにアクセスできます。スレッドが TLS スロットに値を格納するには、TlsSetValue の呼び出しでインデックスを指定します。スレッドは、格納された値を取得するために、その後の TlsGetValue の呼び出しで同じインデックスを指定します。
TLS インデックスはプロセスの境界を越えて有効ではありません。DLL は、あるプロセスで割り当てられたインデックスが別のプロセスで有効であると仮定できません。
例
例については、Using Thread Local Storage または Using Thread Local Storage in a Dynamic-Link Library を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
DWORD TlsAlloc(void);[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint TlsAlloc();<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TlsAlloc() As UInteger
End FunctionDeclare PtrSafe Function TlsAlloc Lib "kernel32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
TlsAlloc = ctypes.windll.kernel32.TlsAlloc
TlsAlloc.restype = wintypes.DWORD
TlsAlloc.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
TlsAlloc = Fiddle::Function.new(
lib['TlsAlloc'],
[],
-Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn TlsAlloc() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint TlsAlloc();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TlsAlloc' -Namespace Win32 -PassThru
# $api::TlsAlloc()#uselib "KERNEL32.dll"
#func global TlsAlloc "TlsAlloc"
; TlsAlloc ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global TlsAlloc "TlsAlloc"
; res = TlsAlloc(); DWORD TlsAlloc()
#uselib "KERNEL32.dll"
#cfunc global TlsAlloc "TlsAlloc"
; res = TlsAlloc()import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procTlsAlloc = kernel32.NewProc("TlsAlloc")
)
r1, _, err := procTlsAlloc.Call()
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction TlsAlloc: DWORD; stdcall;
external 'KERNEL32.dll' name 'TlsAlloc';result := DllCall("KERNEL32\TlsAlloc", "UInt")●TlsAlloc() = DLL("KERNEL32.dll", "dword TlsAlloc()")
# 呼び出し: TlsAlloc()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn TlsAlloc() callconv(std.os.windows.WINAPI) u32;proc TlsAlloc(): uint32 {.importc: "TlsAlloc", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint TlsAlloc();ccall((:TlsAlloc, "KERNEL32.dll"), stdcall, UInt32,
(),
)
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t TlsAlloc(void);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.TlsAlloc()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const TlsAlloc = lib.func('__stdcall', 'TlsAlloc', 'uint32_t', []);
// TlsAlloc()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
TlsAlloc: { parameters: [], result: "u32" },
});
// lib.symbols.TlsAlloc()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t TlsAlloc(void);
C, "KERNEL32.dll");
// $ffi->TlsAlloc();
// 構造体/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);
int TlsAlloc();
}@[Link("kernel32")]
lib LibKERNEL32
fun TlsAlloc = TlsAlloc() : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef TlsAllocNative = Uint32 Function();
typedef TlsAllocDart = int Function();
final TlsAlloc = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<TlsAllocNative, TlsAllocDart>('TlsAlloc');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function TlsAlloc: DWORD; stdcall;
external 'KERNEL32.dll' name 'TlsAlloc';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "TlsAlloc"
c_TlsAlloc :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let tlsalloc =
foreign "TlsAlloc"
(void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("TlsAlloc" tls-alloc :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $TlsAlloc = Win32::API::More->new('KERNEL32',
'DWORD TlsAlloc()');
# my $ret = $TlsAlloc->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。