ホーム › System.Diagnostics.Debug › SymGetLineFromNameW64

SymGetLineFromNameW64

関数

行番号からソース行情報を取得する(Unicode版)。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetLineFromNameW64(
    HANDLE hProcess,
    LPCWSTR ModuleName,   // optional
    LPCWSTR FileName,   // optional
    DWORD dwLineNumber,
    INT* plDisplacement,
    IMAGEHLP_LINEW64* Line
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	最初に SymInitialize 関数に渡したプロセスのハンドル。
ModuleName	LPCWSTR	inoptional	行を検索するモジュールの名前。
FileName	LPCWSTR	inoptional	行を検索するファイルの名前。アプリケーションがこの名前のソースファイルを複数持つ場合は、必ずフルパスを指定してください。
dwLineNumber	DWORD	in	検索する行番号。
plDisplacement	INT*	out	行の先頭からのバイト単位の変位、または 0。
Line	IMAGEHLP_LINEW64*	inout	IMAGEHLP_LINE64 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したモジュール、ファイル名、行番号に対応するソース行を検索します。(SymGetLineFromNameW64)

戻り値

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

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

解説(Remarks)

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

この関数を呼び出す前に、まず SymInitialize、 SymSetOptions、 SymLoadModule64 を呼び出して、シンボルが正しく初期化されていることを確認してください。

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

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

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


BOOL
IMAGEAPI
SymGetLineFromNameW64(
    __in HANDLE hProcess,
    __in_opt PCWSTR ModuleName,
    __in_opt PCWSTR FileName,
    __in DWORD dwLineNumber,
    __out PLONG plDisplacement,
    __inout PIMAGEHLP_LINEW64 Line
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
#define SymGetLineFromName64   SymGetLineFromNameW64
#endif

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetLineFromName SymGetLineFromName64
#else
BOOL
IMAGEAPI
SymGetLineFromName(
    __in HANDLE hProcess,
    __in_opt PCSTR ModuleName,
    __in_opt PCSTR FileName,
    __in DWORD dwLineNumber,
    __out PLONG plDisplacement,
    __inout PIMAGEHLP_LINE Line
    );
#endif

例

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

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

各言語での呼び出し定義

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

BOOL SymGetLineFromNameW64(
    HANDLE hProcess,
    LPCWSTR ModuleName,   // optional
    LPCWSTR FileName,   // optional
    DWORD dwLineNumber,
    INT* plDisplacement,
    IMAGEHLP_LINEW64* Line
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymGetLineFromNameW64(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string ModuleName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR optional
    uint dwLineNumber,   // DWORD
    out int plDisplacement,   // INT* out
    IntPtr Line   // IMAGEHLP_LINEW64* in/out
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetLineFromNameW64(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> ModuleName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR optional
    dwLineNumber As UInteger,   ' DWORD
    <Out> ByRef plDisplacement As Integer,   ' INT* out
    Line As IntPtr   ' IMAGEHLP_LINEW64* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' ModuleName : LPCWSTR optional
' FileName : LPCWSTR optional
' dwLineNumber : DWORD
' plDisplacement : INT* out
' Line : IMAGEHLP_LINEW64* in/out
Declare PtrSafe Function SymGetLineFromNameW64 Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal ModuleName As LongPtr, _
    ByVal FileName As LongPtr, _
    ByVal dwLineNumber As Long, _
    ByRef plDisplacement 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

SymGetLineFromNameW64 = ctypes.windll.dbghelp.SymGetLineFromNameW64
SymGetLineFromNameW64.restype = wintypes.BOOL
SymGetLineFromNameW64.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCWSTR,  # ModuleName : LPCWSTR optional
    wintypes.LPCWSTR,  # FileName : LPCWSTR optional
    wintypes.DWORD,  # dwLineNumber : DWORD
    ctypes.POINTER(ctypes.c_int),  # plDisplacement : INT* out
    ctypes.c_void_p,  # Line : IMAGEHLP_LINEW64* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetLineFromNameW64 = Fiddle::Function.new(
  lib['SymGetLineFromNameW64'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # ModuleName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwLineNumber : DWORD
    Fiddle::TYPE_VOIDP,  # plDisplacement : INT* out
    Fiddle::TYPE_VOIDP,  # Line : IMAGEHLP_LINEW64* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetLineFromNameW64(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        ModuleName: *const u16,  // LPCWSTR optional
        FileName: *const u16,  // LPCWSTR optional
        dwLineNumber: u32,  // DWORD
        plDisplacement: *mut i32,  // INT* out
        Line: *mut IMAGEHLP_LINEW64  // IMAGEHLP_LINEW64* in/out
    ) -> 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 SymGetLineFromNameW64(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string ModuleName, [MarshalAs(UnmanagedType.LPWStr)] string FileName, uint dwLineNumber, out int plDisplacement, IntPtr Line);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetLineFromNameW64' -Namespace Win32 -PassThru
# $api::SymGetLineFromNameW64(hProcess, ModuleName, FileName, dwLineNumber, plDisplacement, Line)

#uselib "dbghelp.dll"
#func global SymGetLineFromNameW64 "SymGetLineFromNameW64" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetLineFromNameW64 hProcess, ModuleName, FileName, dwLineNumber, varptr(plDisplacement), varptr(Line)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; ModuleName : LPCWSTR optional -> "sptr"
; FileName : LPCWSTR optional -> "sptr"
; dwLineNumber : DWORD -> "sptr"
; plDisplacement : INT* out -> "sptr"
; Line : IMAGEHLP_LINEW64* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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