Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › SymGetSourceFile

SymGetSourceFile

関数
シンボルストアからソースファイルを取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetSourceFile(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR Params,   // optional
    LPCSTR FileSpec,
    LPSTR FilePath,
    DWORD Size
);

パラメーター

名前方向
hProcessHANDLEin
BaseULONGLONGin
ParamsLPCSTRinoptional
FileSpecLPCSTRin
FilePathLPSTRout
SizeDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SymGetSourceFile(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR Params,   // optional
    LPCSTR FileSpec,
    LPSTR FilePath,
    DWORD Size
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSourceFile(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPStr)] string Params,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string FileSpec,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder FilePath,   // LPSTR out
    uint Size   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSourceFile(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPStr)> Params As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> FileSpec As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> FilePath As System.Text.StringBuilder,   ' LPSTR out
    Size As UInteger   ' DWORD
) As Boolean
End Function
' hProcess : HANDLE
' Base : ULONGLONG
' Params : LPCSTR optional
' FileSpec : LPCSTR
' FilePath : LPSTR out
' Size : DWORD
Declare PtrSafe Function SymGetSourceFile Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal Params As String, _
    ByVal FileSpec As String, _
    ByVal FilePath As String, _
    ByVal Size As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymGetSourceFile = ctypes.windll.dbghelp.SymGetSourceFile
SymGetSourceFile.restype = wintypes.BOOL
SymGetSourceFile.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCSTR,  # Params : LPCSTR optional
    wintypes.LPCSTR,  # FileSpec : LPCSTR
    wintypes.LPSTR,  # FilePath : LPSTR out
    wintypes.DWORD,  # Size : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSourceFile = Fiddle::Function.new(
  lib['SymGetSourceFile'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Params : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # FileSpec : LPCSTR
    Fiddle::TYPE_VOIDP,  # FilePath : LPSTR out
    -Fiddle::TYPE_INT,  # Size : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceFile(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        Params: *const u8,  // LPCSTR optional
        FileSpec: *const u8,  // LPCSTR
        FilePath: *mut u8,  // LPSTR out
        Size: u32  // DWORD
    ) -> 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 SymGetSourceFile(IntPtr hProcess, ulong Base, [MarshalAs(UnmanagedType.LPStr)] string Params, [MarshalAs(UnmanagedType.LPStr)] string FileSpec, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder FilePath, uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceFile' -Namespace Win32 -PassThru
# $api::SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
#uselib "dbghelp.dll"
#func global SymGetSourceFile "SymGetSourceFile" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetSourceFile hProcess, Base, Params, FileSpec, varptr(FilePath), Size   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "sptr"
; Params : LPCSTR optional -> "sptr"
; FileSpec : LPCSTR -> "sptr"
; FilePath : LPSTR out -> "sptr"
; Size : DWORD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymGetSourceFile "SymGetSourceFile" sptr, int64, str, str, var, int
; res = SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; Params : LPCSTR optional -> "str"
; FileSpec : LPCSTR -> "str"
; FilePath : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SymGetSourceFile(HANDLE hProcess, ULONGLONG Base, LPCSTR Params, LPCSTR FileSpec, LPSTR FilePath, DWORD Size)
#uselib "dbghelp.dll"
#cfunc global SymGetSourceFile "SymGetSourceFile" intptr, int64, str, str, var, int
; res = SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
; hProcess : HANDLE -> "intptr"
; Base : ULONGLONG -> "int64"
; Params : LPCSTR optional -> "str"
; FileSpec : LPCSTR -> "str"
; FilePath : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceFile = dbghelp.NewProc("SymGetSourceFile")
)

// hProcess (HANDLE), Base (ULONGLONG), Params (LPCSTR optional), FileSpec (LPCSTR), FilePath (LPSTR out), Size (DWORD)
r1, _, err := procSymGetSourceFile.Call(
	uintptr(hProcess),
	uintptr(Base),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(Params))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(FileSpec))),
	uintptr(FilePath),
	uintptr(Size),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymGetSourceFile(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  Params: PAnsiChar;   // LPCSTR optional
  FileSpec: PAnsiChar;   // LPCSTR
  FilePath: PAnsiChar;   // LPSTR out
  Size: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSourceFile';
result := DllCall("dbghelp\SymGetSourceFile"
    , "Ptr", hProcess   ; HANDLE
    , "Int64", Base   ; ULONGLONG
    , "AStr", Params   ; LPCSTR optional
    , "AStr", FileSpec   ; LPCSTR
    , "Ptr", FilePath   ; LPSTR out
    , "UInt", Size   ; DWORD
    , "Int")   ; return: BOOL
●SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size) = DLL("dbghelp.dll", "bool SymGetSourceFile(void*, qword, char*, char*, char*, dword)")
# 呼び出し: SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
# hProcess : HANDLE -> "void*"
# Base : ULONGLONG -> "qword"
# Params : LPCSTR optional -> "char*"
# FileSpec : LPCSTR -> "char*"
# FilePath : LPSTR out -> "char*"
# Size : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。