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

SetThreadStackGuarantee

関数
スレッドスタックの予約保証サイズを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetThreadStackGuarantee(
    DWORD* StackSizeInBytes
);

パラメーター

名前方向説明
StackSizeInBytesDWORD*inout

スタックのサイズ(バイト単位)。戻り時には、この値には以前のスタックのサイズ(バイト単位)が設定されます。

このパラメーターが 0(ゼロ)の場合、関数は成功し、パラメーターには現在のスタックのサイズが格納されます。

指定したサイズが現在のサイズより小さい場合、関数は成功しますが、この要求は無視されます。したがって、この関数を使用してスタックのサイズを縮小することはできません。

この値は、予約されたスタックサイズより大きくすることはできません。

戻り値の型: BOOL

公式ドキュメント

呼び出し元のスレッドまたはファイバーに関連付けられたスタックについて、スタックオーバーフロー例外の発生中に利用可能となる最小サイズを設定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

関数が成功した場合、アプリケーションは 構造化例外処理を使用して、発生する可能性のある EXCEPTION_STACK_OVERFLOW 例外を処理できます。スタックオーバーフローを処理した後に実行を再開するには、特定の回復手順を実行する必要があります。Microsoft C/C++ コンパイラを使用している場合は、_resetstkoflw 関数を呼び出します。別のコンパイラを使用している場合は、スタックオーバーフローからの回復方法についてそのコンパイラのドキュメントを参照してください。

ファイバーのスタック保証を設定するには、まず SwitchToFiber 関数を呼び出してファイバーを実行する必要があります。このファイバーに対して保証を設定した後は、どのスレッドがそのファイバーを実行するかに関係なく、その保証がファイバーによって使用されます。

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

各言語での呼び出し定義

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

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

SetThreadStackGuarantee = ctypes.windll.kernel32.SetThreadStackGuarantee
SetThreadStackGuarantee.restype = wintypes.BOOL
SetThreadStackGuarantee.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # StackSizeInBytes : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadStackGuarantee = Fiddle::Function.new(
  lib['SetThreadStackGuarantee'],
  [
    Fiddle::TYPE_VOIDP,  # StackSizeInBytes : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadStackGuarantee(
        StackSizeInBytes: *mut u32  // DWORD* in/out
    ) -> 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 SetThreadStackGuarantee(ref uint StackSizeInBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadStackGuarantee' -Namespace Win32 -PassThru
# $api::SetThreadStackGuarantee(StackSizeInBytes)
#uselib "KERNEL32.dll"
#func global SetThreadStackGuarantee "SetThreadStackGuarantee" sptr
; SetThreadStackGuarantee varptr(StackSizeInBytes)   ; 戻り値は stat
; StackSizeInBytes : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetThreadStackGuarantee "SetThreadStackGuarantee" var
; res = SetThreadStackGuarantee(StackSizeInBytes)
; StackSizeInBytes : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetThreadStackGuarantee(DWORD* StackSizeInBytes)
#uselib "KERNEL32.dll"
#cfunc global SetThreadStackGuarantee "SetThreadStackGuarantee" var
; res = SetThreadStackGuarantee(StackSizeInBytes)
; StackSizeInBytes : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadStackGuarantee = kernel32.NewProc("SetThreadStackGuarantee")
)

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

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

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

foreign import stdcall safe "SetThreadStackGuarantee"
  c_SetThreadStackGuarantee :: Ptr Word32 -> IO CInt
-- StackSizeInBytes : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SetThreadStackGuarantee" set-thread-stack-guarantee :convention :stdcall) :int32
  (stack-size-in-bytes :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadStackGuarantee = Win32::API::More->new('KERNEL32',
    'BOOL SetThreadStackGuarantee(LPVOID StackSizeInBytes)');
# my $ret = $SetThreadStackGuarantee->Call($StackSizeInBytes);
# StackSizeInBytes : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。