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

DisableThreadLibraryCalls

関数
DLLのスレッドアタッチ・デタッチ通知を無効化する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL DisableThreadLibraryCalls(
    HMODULE hLibModule
);

パラメーター

名前方向説明
hLibModuleHMODULEinDLL_THREAD_ATTACH および DLL_THREAD_DETACH の通知を無効にする DLL モジュールへのハンドルです。このハンドルは LoadLibraryLoadLibraryEx、または GetModuleHandle 関数によって返されます。なお、GetModuleHandleNULL で呼び出すことはできません。これは DLL イメージではなく実行可能イメージのベースアドレスを返すためです。

戻り値の型: BOOL

公式ドキュメント

指定したダイナミックリンクライブラリ (DLL) に対する DLL_THREAD_ATTACH および DLL_THREAD_DETACH の通知を無効にします。

戻り値

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

関数が失敗すると、戻り値は 0 になります。DisableThreadLibraryCalls 関数は、hModule で指定された DLL がアクティブな静的スレッドローカルストレージを持つ場合、または hModule が無効なモジュールハンドルである場合に失敗します。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

DisableThreadLibraryCalls 関数を使用すると、DLL は DLL_THREAD_ATTACH および DLL_THREAD_DETACH の通知呼び出しを無効にできます。これは、多数の DLL を持ち、スレッドの作成と削除を頻繁に行い、かつその DLL がアタッチ/デタッチに関するスレッドレベルの通知を必要としないマルチスレッドアプリケーションにとって、有用な最適化となります。リモートプロシージャコール (RPC) サーバーアプリケーションは、そのようなアプリケーションの一例です。この種のアプリケーションでは、DLL の初期化ルーチンが DLL_THREAD_ATTACH および DLL_THREAD_DETACH の通知に対応するために、しばしばメモリ上に残り続けます。通知を無効にすると、スレッドの作成や削除のために DLL 初期化コードがページインされなくなり、その結果アプリケーションのワーキングコードセットのサイズが削減されます。この最適化を実装するには、DLL の DLL_PROCESS_ATTACH コードを変更して DisableThreadLibraryCalls を呼び出すようにします。

静的 C ランタイムライブラリ (CRT) にリンクされた DLL からこの関数を呼び出さないでください。静的 CRT が正しく機能するには、DLL_THREAD_ATTACH および DLL_THREAD_DETATCH の通知が必要です。

この関数は、静的 スレッドローカルストレージ (TLS) が有効な場合、いかなる最適化も行いません。静的 TLS は、thread_local 変数、__declspec( thread ) 変数、または関数ローカルの static を使用する場合に有効になります。

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

各言語での呼び出し定義

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

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

DisableThreadLibraryCalls = ctypes.windll.kernel32.DisableThreadLibraryCalls
DisableThreadLibraryCalls.restype = wintypes.BOOL
DisableThreadLibraryCalls.argtypes = [
    wintypes.HANDLE,  # hLibModule : HMODULE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDisableThreadLibraryCalls = kernel32.NewProc("DisableThreadLibraryCalls")
)

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

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

typedef DisableThreadLibraryCallsNative = Int32 Function(Pointer<Void>);
typedef DisableThreadLibraryCallsDart = int Function(Pointer<Void>);
final DisableThreadLibraryCalls = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DisableThreadLibraryCallsNative, DisableThreadLibraryCallsDart>('DisableThreadLibraryCalls');
// hLibModule : HMODULE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DisableThreadLibraryCalls(
  hLibModule: THandle   // HMODULE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DisableThreadLibraryCalls';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("DisableThreadLibraryCalls" disable-thread-library-calls :convention :stdcall) :int32
  (h-lib-module :pointer))   ; HMODULE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DisableThreadLibraryCalls = Win32::API::More->new('KERNEL32',
    'BOOL DisableThreadLibraryCalls(HANDLE hLibModule)');
# my $ret = $DisableThreadLibraryCalls->Call($hLibModule);
# hLibModule : HMODULE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。