ホーム › System.Diagnostics.Debug › SymGetLineFromAddr

SymGetLineFromAddr

関数

アドレスに対応するソース行情報を取得する。

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

シグネチャ

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

BOOL SymGetLineFromAddr(
    HANDLE hProcess,
    DWORD dwAddr,
    DWORD* pdwDisplacement,
    IMAGEHLP_LINE* Line
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

指定したアドレスに対応するソース行を特定します。(SymGetLineFromAddr)

戻り値

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

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

解説(Remarks)

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

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

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

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。 SymGetLineFromAddrW64 は Dbghelp.h で次のように定義されています。

BOOL
IMAGEAPI
SymGetLineFromAddrW64(
    _In_ HANDLE hProcess,
    _In_ DWORD64 dwAddr,
    _Out_ PDWORD pdwDisplacement,
    _Out_ PIMAGEHLP_LINEW64 Line
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
 #define SymGetLineFromAddr64   SymGetLineFromAddrW64
#endif

この関数は SymGetLineFromAddr 関数に取って代わるものです。詳細については、 Updated Platform Support を参照してください。SymGetLineFromAddr は Dbghelp.h で次のように定義されています。

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetLineFromAddr SymGetLineFromAddr64
#define SymGetLineFromAddrW SymGetLineFromAddrW64
#else
BOOL
IMAGEAPI
SymGetLineFromAddr(
    _In_ HANDLE hProcess,
    _In_ DWORD dwAddr,
    _Out_ PDWORD pdwDisplacement,
    _Out_ PIMAGEHLP_LINE Line
    );

BOOL
IMAGEAPI
SymGetLineFromAddrW(
    _In_ HANDLE hProcess,
    _In_ DWORD dwAddr,
    _Out_ PDWORD pdwDisplacement,
    _Out_ PIMAGEHLP_LINEW Line
    );
#endif

例

例については、 Retrieving Symbol Information by Address を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymGetLineFromAddr(
    HANDLE hProcess,
    DWORD dwAddr,
    DWORD* pdwDisplacement,
    IMAGEHLP_LINE* Line
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetLineFromAddr(
    IntPtr hProcess,   // HANDLE
    uint dwAddr,   // DWORD
    out uint pdwDisplacement,   // DWORD* out
    IntPtr Line   // IMAGEHLP_LINE* out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetLineFromAddr(
    hProcess As IntPtr,   ' HANDLE
    dwAddr As UInteger,   ' DWORD
    <Out> ByRef pdwDisplacement As UInteger,   ' DWORD* out
    Line As IntPtr   ' IMAGEHLP_LINE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' dwAddr : DWORD
' pdwDisplacement : DWORD* out
' Line : IMAGEHLP_LINE* out
Declare PtrSafe Function SymGetLineFromAddr Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal dwAddr As Long, _
    ByRef pdwDisplacement As Long, _
    ByVal Line As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetLineFromAddr = ctypes.windll.dbghelp.SymGetLineFromAddr
SymGetLineFromAddr.restype = wintypes.BOOL
SymGetLineFromAddr.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # dwAddr : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwDisplacement : DWORD* out
    ctypes.c_void_p,  # Line : IMAGEHLP_LINE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetLineFromAddr = Fiddle::Function.new(
  lib['SymGetLineFromAddr'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # dwAddr : DWORD
    Fiddle::TYPE_VOIDP,  # pdwDisplacement : DWORD* out
    Fiddle::TYPE_VOIDP,  # Line : IMAGEHLP_LINE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetLineFromAddr(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        dwAddr: u32,  // DWORD
        pdwDisplacement: *mut u32,  // DWORD* out
        Line: *mut IMAGEHLP_LINE  // IMAGEHLP_LINE* 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 SymGetLineFromAddr(IntPtr hProcess, uint dwAddr, out uint pdwDisplacement, IntPtr Line);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetLineFromAddr' -Namespace Win32 -PassThru
# $api::SymGetLineFromAddr(hProcess, dwAddr, pdwDisplacement, Line)

#uselib "dbghelp.dll"
#func global SymGetLineFromAddr "SymGetLineFromAddr" sptr, sptr, sptr, sptr
; SymGetLineFromAddr hProcess, dwAddr, varptr(pdwDisplacement), varptr(Line)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; dwAddr : DWORD -> "sptr"
; pdwDisplacement : DWORD* out -> "sptr"
; Line : IMAGEHLP_LINE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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