ホーム › System.Diagnostics.Debug › SymGetLineFromInlineContextW

SymGetLineFromInlineContextW

関数

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

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

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetLineFromInlineContextW(
    HANDLE hProcess,
    ULONGLONG dwAddr,
    DWORD InlineContext,
    ULONGLONG qwModuleBaseAddress,   // optional
    DWORD* pdwDisplacement,
    IMAGEHLP_LINEW64* Line
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

SymGetLineFromInlineContextW (Unicode) 関数は、指定されたインラインコンテキストのソース行を特定します。

戻り値

関数が成功した場合、戻り値は 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

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして SymGetLineFromInlineContext を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetLineFromInlineContextW(
    HANDLE hProcess,
    ULONGLONG dwAddr,
    DWORD InlineContext,
    ULONGLONG qwModuleBaseAddress,   // optional
    DWORD* pdwDisplacement,
    IMAGEHLP_LINEW64* Line
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetLineFromInlineContextW(
    IntPtr hProcess,   // HANDLE
    ulong dwAddr,   // ULONGLONG
    uint InlineContext,   // DWORD
    ulong qwModuleBaseAddress,   // ULONGLONG optional
    out uint pdwDisplacement,   // DWORD* out
    IntPtr Line   // IMAGEHLP_LINEW64* out
);

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

' hProcess : HANDLE
' dwAddr : ULONGLONG
' InlineContext : DWORD
' qwModuleBaseAddress : ULONGLONG optional
' pdwDisplacement : DWORD* out
' Line : IMAGEHLP_LINEW64* out
Declare PtrSafe Function SymGetLineFromInlineContextW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal dwAddr As LongLong, _
    ByVal InlineContext As Long, _
    ByVal qwModuleBaseAddress As LongLong, _
    ByRef pdwDisplacement As Long, _
    ByVal Line As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetLineFromInlineContextW = Fiddle::Function.new(
  lib['SymGetLineFromInlineContextW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # dwAddr : ULONGLONG
    -Fiddle::TYPE_INT,  # InlineContext : DWORD
    -Fiddle::TYPE_LONG_LONG,  # qwModuleBaseAddress : ULONGLONG optional
    Fiddle::TYPE_VOIDP,  # pdwDisplacement : DWORD* out
    Fiddle::TYPE_VOIDP,  # Line : IMAGEHLP_LINEW64* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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