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プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseULONGLONGinモジュールのベースアドレス。
ParamsLPCSTRinoptionalこのパラメーターは使用されません。
FileSpecLPCSTRinソースファイルの名前。
FilePathLPSTRoutソースファイルの完全修飾パスを受け取る バッファーへのポインター。
SizeDWORDinFilePath バッファーのサイズ(文字数)。

戻り値の型: BOOL

公式ドキュメント

SymGetSourceFile 関数 (dbghelp.h) は、指定されたソースファイルをソースサーバーから取得します。

戻り値

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

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

解説(Remarks)

ソースファイルを受け取るディレクトリを制御するには、SymSetHomeDirectory 関数を使用します。

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "dbghelp" fn SymGetSourceFile(
    hProcess: ?*anyopaque, // HANDLE
    Base: u64, // ULONGLONG
    Params: [*c]const u8, // LPCSTR optional
    FileSpec: [*c]const u8, // LPCSTR
    FilePath: [*c]u8, // LPSTR out
    Size: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SymGetSourceFile(
    hProcess: pointer,  # HANDLE
    Base: uint64,  # ULONGLONG
    Params: cstring,  # LPCSTR optional
    FileSpec: cstring,  # LPCSTR
    FilePath: ptr char,  # LPSTR out
    Size: uint32  # DWORD
): int32 {.importc: "SymGetSourceFile", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymGetSourceFile(
    void* hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    const(char)* Params,   // LPCSTR optional
    const(char)* FileSpec,   // LPCSTR
    char* FilePath,   // LPSTR out
    uint Size   // DWORD
);
ccall((:SymGetSourceFile, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, Cstring, Cstring, Ptr{UInt8}, UInt32),
      hProcess, Base, Params, FileSpec, FilePath, Size)
# hProcess : HANDLE -> Ptr{Cvoid}
# Base : ULONGLONG -> UInt64
# Params : LPCSTR optional -> Cstring
# FileSpec : LPCSTR -> Cstring
# FilePath : LPSTR out -> Ptr{UInt8}
# Size : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymGetSourceFile(
    void* hProcess,
    uint64_t Base,
    const char* Params,
    const char* FileSpec,
    char* FilePath,
    uint32_t Size);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
-- hProcess : HANDLE
-- Base : ULONGLONG
-- Params : LPCSTR optional
-- FileSpec : LPCSTR
-- FilePath : LPSTR out
-- Size : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymGetSourceFile = lib.func('__stdcall', 'SymGetSourceFile', 'int32_t', ['void *', 'uint64_t', 'str', 'str', 'char *', 'uint32_t']);
// SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
// hProcess : HANDLE -> 'void *'
// Base : ULONGLONG -> 'uint64_t'
// Params : LPCSTR optional -> 'str'
// FileSpec : LPCSTR -> 'str'
// FilePath : LPSTR out -> 'char *'
// Size : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymGetSourceFile: { parameters: ["pointer", "u64", "buffer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size)
// hProcess : HANDLE -> "pointer"
// Base : ULONGLONG -> "u64"
// Params : LPCSTR optional -> "buffer"
// FileSpec : LPCSTR -> "buffer"
// FilePath : LPSTR out -> "buffer"
// Size : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymGetSourceFile(
    void* hProcess,
    uint64_t Base,
    const char* Params,
    const char* FileSpec,
    char* FilePath,
    uint32_t Size);
C, "dbghelp.dll");
// $ffi->SymGetSourceFile(hProcess, Base, Params, FileSpec, FilePath, Size);
// hProcess : HANDLE
// Base : ULONGLONG
// Params : LPCSTR optional
// FileSpec : LPCSTR
// FilePath : LPSTR out
// Size : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.ASCII_OPTIONS);
    boolean SymGetSourceFile(
        Pointer hProcess,   // HANDLE
        long Base,   // ULONGLONG
        String Params,   // LPCSTR optional
        String FileSpec,   // LPCSTR
        byte[] FilePath,   // LPSTR out
        int Size   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymGetSourceFile = SymGetSourceFile(
    hProcess : Void*,   # HANDLE
    Base : UInt64,   # ULONGLONG
    Params : UInt8*,   # LPCSTR optional
    FileSpec : UInt8*,   # LPCSTR
    FilePath : UInt8*,   # LPSTR out
    Size : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymGetSourceFileNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef SymGetSourceFileDart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int);
final SymGetSourceFile = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSourceFileNative, SymGetSourceFileDart>('SymGetSourceFile');
// hProcess : HANDLE -> Pointer<Void>
// Base : ULONGLONG -> Uint64
// Params : LPCSTR optional -> Pointer<Utf8>
// FileSpec : LPCSTR -> Pointer<Utf8>
// FilePath : LPSTR out -> Pointer<Utf8>
// Size : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetSourceFile"
  c_SymGetSourceFile :: Ptr () -> Word64 -> CString -> CString -> CString -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Base : ULONGLONG -> Word64
-- Params : LPCSTR optional -> CString
-- FileSpec : LPCSTR -> CString
-- FilePath : LPSTR out -> CString
-- Size : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgetsourcefile =
  foreign "SymGetSourceFile"
    ((ptr void) @-> uint64_t @-> string @-> string @-> string @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Base : ULONGLONG -> uint64_t *)
(* Params : LPCSTR optional -> string *)
(* FileSpec : LPCSTR -> string *)
(* FilePath : LPSTR out -> string *)
(* Size : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetSourceFile" sym-get-source-file :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base :uint64)   ; ULONGLONG
  (params :string)   ; LPCSTR optional
  (file-spec :string)   ; LPCSTR
  (file-path :pointer)   ; LPSTR out
  (size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSourceFile = Win32::API::More->new('dbghelp',
    'BOOL SymGetSourceFile(HANDLE hProcess, UINT64 Base, LPCSTR Params, LPCSTR FileSpec, LPSTR FilePath, DWORD Size)');
# my $ret = $SymGetSourceFile->Call($hProcess, $Base, $Params, $FileSpec, $FilePath, $Size);
# hProcess : HANDLE -> HANDLE
# Base : ULONGLONG -> UINT64
# Params : LPCSTR optional -> LPCSTR
# FileSpec : LPCSTR -> LPCSTR
# FilePath : LPSTR out -> LPSTR
# Size : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い