ホーム › System.Diagnostics.Debug › SymSetContext

SymSetContext

関数

シンボル検索用のスタックフレームコンテキストを設定する。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSetContext(
    HANDLE hProcess,
    IMAGEHLP_STACK_FRAME* StackFrame,
    void* Context   // optional
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
StackFrame	IMAGEHLP_STACK_FRAME*	in	フレーム情報を格納する IMAGEHLP_STACK_FRAME 構造体へのポインター。
Context	void*	inoptional	このパラメーターは無視されます。

戻り値の型: BOOL

公式ドキュメント

SymEnumSymbols 関数で使用されるコンテキスト情報を設定します。この関数は PDB シンボルでのみ動作します。

戻り値

関数が成功した場合、戻り値は TRUE です。

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

解説(Remarks)

SymSetContext を呼び出してコンテキストを現在の値に設定した場合、関数は失敗しますが、GetLastError は ERROR_SUCCESS を返します。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への並行呼び出しをすべて同期する必要があります。

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

各言語での呼び出し定義

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

BOOL SymSetContext(
    HANDLE hProcess,
    IMAGEHLP_STACK_FRAME* StackFrame,
    void* Context   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymSetContext(
    IntPtr hProcess,   // HANDLE
    IntPtr StackFrame,   // IMAGEHLP_STACK_FRAME*
    IntPtr Context   // void* optional
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetContext(
    hProcess As IntPtr,   ' HANDLE
    StackFrame As IntPtr,   ' IMAGEHLP_STACK_FRAME*
    Context As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' StackFrame : IMAGEHLP_STACK_FRAME*
' Context : void* optional
Declare PtrSafe Function SymSetContext Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal StackFrame As LongPtr, _
    ByVal Context As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymSetContext = ctypes.windll.dbghelp.SymSetContext
SymSetContext.restype = wintypes.BOOL
SymSetContext.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_void_p,  # StackFrame : IMAGEHLP_STACK_FRAME*
    ctypes.POINTER(None),  # Context : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSetContext = Fiddle::Function.new(
  lib['SymSetContext'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # StackFrame : IMAGEHLP_STACK_FRAME*
    Fiddle::TYPE_VOIDP,  # Context : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymSetContext(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        StackFrame: *mut IMAGEHLP_STACK_FRAME,  // IMAGEHLP_STACK_FRAME*
        Context: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool SymSetContext(IntPtr hProcess, IntPtr StackFrame, IntPtr Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSetContext' -Namespace Win32 -PassThru
# $api::SymSetContext(hProcess, StackFrame, Context)

#uselib "dbghelp.dll"
#func global SymSetContext "SymSetContext" sptr, sptr, sptr
; SymSetContext hProcess, varptr(StackFrame), Context   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; StackFrame : IMAGEHLP_STACK_FRAME* -> "sptr"
; Context : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymSetContext "SymSetContext" sptr, var, sptr
; res = SymSetContext(hProcess, StackFrame, Context)
; hProcess : HANDLE -> "sptr"
; StackFrame : IMAGEHLP_STACK_FRAME* -> "var"
; Context : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymSetContext "SymSetContext" sptr, sptr, sptr
; res = SymSetContext(hProcess, varptr(StackFrame), Context)
; hProcess : HANDLE -> "sptr"
; StackFrame : IMAGEHLP_STACK_FRAME* -> "sptr"
; Context : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。