ホーム › System.Diagnostics.Debug › SymGetLineFromInlineContext

SymGetLineFromInlineContext

関数

インラインコンテキストを考慮して指定アドレスのソース行情報を取得する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymGetLineFromInlineContext(
    HANDLE hProcess,
    ULONGLONG qwAddr,
    DWORD InlineContext,
    ULONGLONG qwModuleBaseAddress,   // optional
    DWORD* pdwDisplacement,
    IMAGEHLP_LINE64* Line64
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	元々 SymInitialize 関数に渡されたプロセスへのハンドル。
qwAddr	ULONGLONG	in	行を特定する対象のアドレス。アドレスが行の境界上にある必要はありません。アドレスが行の先頭以降かつ行の末尾より前に位置する場合、その行が検出されます。
InlineContext	DWORD	in	インラインコンテキスト。
qwModuleBaseAddress	ULONGLONG	inoptional	モジュールのベースアドレス。
pdwDisplacement	DWORD*	out	行の先頭からのバイト単位の変位、またはゼロ。
Line64	IMAGEHLP_LINE64*	out	IMAGEHLP_LINE64 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymGetLineFromInlineContext 関数 (dbghelp.h) は、指定されたインラインコンテキストに対応するソース行を特定します。

戻り値

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

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

解説(Remarks)

呼び出し元は、SymGetLineFromInlineContext を呼び出す前に、Line バッファーを適切に割り当て、IMAGEHLP_LINE64 構造体の必須メンバーを設定する必要があります。

この関数は、別の関数によって再利用される可能性のあるバッファーへのポインターを返します。そのため、返されたデータは直ちに別のバッファーにコピーしてください。

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。SymGetLineFromInlineContext は Dbghelp.h で次のように定義されています。

BOOL
IMAGEAPI
SymGetLineFromInlineContextW(
    _In_ HANDLE hProcess,
    _In_ DWORD64 dwAddr,
    _In_ ULONG InlineContext,
    _In_opt_ DWORD64 qwModuleBaseAddress,
    _Out_ PDWORD pdwDisplacement,
    _Out_ PIMAGEHLP_LINEW64 Line
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
 #define SymGetLineFromInlineContext SymGetLineFromInlineContextW
#endif

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

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymGetLineFromInlineContext(
    HANDLE hProcess,
    ULONGLONG qwAddr,
    DWORD InlineContext,
    ULONGLONG qwModuleBaseAddress,   // optional
    DWORD* pdwDisplacement,
    IMAGEHLP_LINE64* Line64
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetLineFromInlineContext(
    IntPtr hProcess,   // HANDLE
    ulong qwAddr,   // ULONGLONG
    uint InlineContext,   // DWORD
    ulong qwModuleBaseAddress,   // ULONGLONG optional
    out uint pdwDisplacement,   // DWORD* out
    IntPtr Line64   // IMAGEHLP_LINE64* out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetLineFromInlineContext(
    hProcess As IntPtr,   ' HANDLE
    qwAddr As ULong,   ' ULONGLONG
    InlineContext As UInteger,   ' DWORD
    qwModuleBaseAddress As ULong,   ' ULONGLONG optional
    <Out> ByRef pdwDisplacement As UInteger,   ' DWORD* out
    Line64 As IntPtr   ' IMAGEHLP_LINE64* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' qwAddr : ULONGLONG
' InlineContext : DWORD
' qwModuleBaseAddress : ULONGLONG optional
' pdwDisplacement : DWORD* out
' Line64 : IMAGEHLP_LINE64* out
Declare PtrSafe Function SymGetLineFromInlineContext Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal qwAddr As LongLong, _
    ByVal InlineContext As Long, _
    ByVal qwModuleBaseAddress As LongLong, _
    ByRef pdwDisplacement As Long, _
    ByVal Line64 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetLineFromInlineContext = ctypes.windll.dbghelp.SymGetLineFromInlineContext
SymGetLineFromInlineContext.restype = wintypes.BOOL
SymGetLineFromInlineContext.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # qwAddr : ULONGLONG
    wintypes.DWORD,  # InlineContext : DWORD
    ctypes.c_ulonglong,  # qwModuleBaseAddress : ULONGLONG optional
    ctypes.POINTER(wintypes.DWORD),  # pdwDisplacement : DWORD* out
    ctypes.c_void_p,  # Line64 : IMAGEHLP_LINE64* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetLineFromInlineContext = Fiddle::Function.new(
  lib['SymGetLineFromInlineContext'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # qwAddr : ULONGLONG
    -Fiddle::TYPE_INT,  # InlineContext : DWORD
    -Fiddle::TYPE_LONG_LONG,  # qwModuleBaseAddress : ULONGLONG optional
    Fiddle::TYPE_VOIDP,  # pdwDisplacement : DWORD* out
    Fiddle::TYPE_VOIDP,  # Line64 : IMAGEHLP_LINE64* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetLineFromInlineContext(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        qwAddr: u64,  // ULONGLONG
        InlineContext: u32,  // DWORD
        qwModuleBaseAddress: u64,  // ULONGLONG optional
        pdwDisplacement: *mut u32,  // DWORD* out
        Line64: *mut IMAGEHLP_LINE64  // IMAGEHLP_LINE64* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SymGetLineFromInlineContext(IntPtr hProcess, ulong qwAddr, uint InlineContext, ulong qwModuleBaseAddress, out uint pdwDisplacement, IntPtr Line64);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetLineFromInlineContext' -Namespace Win32 -PassThru
# $api::SymGetLineFromInlineContext(hProcess, qwAddr, InlineContext, qwModuleBaseAddress, pdwDisplacement, Line64)

#uselib "dbghelp.dll"
#func global SymGetLineFromInlineContext "SymGetLineFromInlineContext" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetLineFromInlineContext hProcess, qwAddr, InlineContext, qwModuleBaseAddress, varptr(pdwDisplacement), varptr(Line64)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; qwAddr : ULONGLONG -> "sptr"
; InlineContext : DWORD -> "sptr"
; qwModuleBaseAddress : ULONGLONG optional -> "sptr"
; pdwDisplacement : DWORD* out -> "sptr"
; Line64 : IMAGEHLP_LINE64* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetLineFromInlineContext "SymGetLineFromInlineContext" sptr, int64, int, int64, var, var
; res = SymGetLineFromInlineContext(hProcess, qwAddr, InlineContext, qwModuleBaseAddress, pdwDisplacement, Line64)
; hProcess : HANDLE -> "sptr"
; qwAddr : ULONGLONG -> "int64"
; InlineContext : DWORD -> "int"
; qwModuleBaseAddress : ULONGLONG optional -> "int64"
; pdwDisplacement : DWORD* out -> "var"
; Line64 : IMAGEHLP_LINE64* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "dbghelp.dll"
#cfunc global SymGetLineFromInlineContext "SymGetLineFromInlineContext" sptr, int64, int, int64, sptr, sptr
; res = SymGetLineFromInlineContext(hProcess, qwAddr, InlineContext, qwModuleBaseAddress, varptr(pdwDisplacement), varptr(Line64))
; hProcess : HANDLE -> "sptr"
; qwAddr : ULONGLONG -> "int64"
; InlineContext : DWORD -> "int"
; qwModuleBaseAddress : ULONGLONG optional -> "int64"
; pdwDisplacement : DWORD* out -> "sptr"
; Line64 : IMAGEHLP_LINE64* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。