ホーム › System.Diagnostics.Debug › SymLoadModule

SymLoadModule

関数

モジュールのシンボルテーブルを読み込む(旧式API)。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

DWORD SymLoadModule(
    HANDLE hProcess,
    HANDLE hFile,   // optional
    LPCSTR ImageName,   // optional
    LPCSTR ModuleName,   // optional
    DWORD BaseOfDll,
    DWORD SizeOfDll
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
hFile	HANDLE	inoptional	実行可能イメージのファイルへのハンドル。この引数は主にデバッガーで使用され、デバッガーはデバッグイベントから取得したファイルハンドルを渡します。値が NULL の場合、hFile は使用されないことを示します。
ImageName	LPCSTR	inoptional	実行可能イメージの名前。この名前には、部分パス、フルパス、またはパスなしを指定できます。指定された名前でファイルが見つからない場合は、シンボル検索パスが使用されます。
ModuleName	LPCSTR	inoptional	モジュールのショートカット名。ポインター値が NULL の場合、ライブラリはシンボルファイルのベース名を使用して名前を作成します。
BaseOfDll	DWORD	in	モジュールの読み込みアドレス。値がゼロの場合、ライブラリはシンボルファイルから読み込みアドレスを取得します。シンボルファイルに含まれる読み込みアドレスは、必ずしも実際の読み込みアドレスとは限りません。実際の読み込みアドレスを持つデバッガーやその他のアプリケーションは、この関数を呼び出す際に実際の読み込みアドレスを使用してください。イメージが .pdb ファイルの場合、このパラメーターをゼロにすることはできません。
SizeOfDll	DWORD	in	モジュールのサイズ(バイト単位)。値がゼロの場合、ライブラリはシンボルファイルからサイズを取得します。シンボルファイルに含まれるサイズは、必ずしも実際のサイズとは限りません。実際のサイズを持つデバッガーやその他のアプリケーションは、この関数を呼び出す際に実際のサイズを使用してください。イメージが .pdb ファイルの場合、このパラメーターをゼロにすることはできません。

戻り値の型: DWORD

公式ドキュメント

シンボルテーブルを読み込みます。(SymLoadModule)

戻り値

関数が成功した場合、戻り値は読み込まれたモジュールのベースアドレスです。

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

モジュールがすでに読み込まれている場合、戻り値はゼロになり、GetLastError は ERROR_SUCCESS を返します。

解説(Remarks)

シンボルハンドラーはモジュールのエントリを作成し、遅延シンボル読み込みオプションがオフになっている場合はシンボルの読み込みを試みます。遅延シンボル読み込みが有効になっている場合、モジュールは遅延としてマークされ、モジュール内のシンボルが参照されるまでシンボルは読み込まれません。

シンボルテーブルをアンロードするには、 SymUnloadModule64 関数を使用します。

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

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymLoadModule SymLoadModule64
#else
DWORD
IMAGEAPI
SymLoadModule(
    __in HANDLE hProcess,
    __in_opt HANDLE hFile,
    __in_opt PCSTR ImageName,
    __in_opt PCSTR ModuleName,
    __in DWORD BaseOfDll,
    __in DWORD SizeOfDll
    );
#endif

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

各言語での呼び出し定義

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

DWORD SymLoadModule(
    HANDLE hProcess,
    HANDLE hFile,   // optional
    LPCSTR ImageName,   // optional
    LPCSTR ModuleName,   // optional
    DWORD BaseOfDll,
    DWORD SizeOfDll
);

[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern uint SymLoadModule(
    IntPtr hProcess,   // HANDLE
    IntPtr hFile,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string ImageName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string ModuleName,   // LPCSTR optional
    uint BaseOfDll,   // DWORD
    uint SizeOfDll   // DWORD
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymLoadModule(
    hProcess As IntPtr,   ' HANDLE
    hFile As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> ImageName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> ModuleName As String,   ' LPCSTR optional
    BaseOfDll As UInteger,   ' DWORD
    SizeOfDll As UInteger   ' DWORD
) As UInteger
End Function

' hProcess : HANDLE
' hFile : HANDLE optional
' ImageName : LPCSTR optional
' ModuleName : LPCSTR optional
' BaseOfDll : DWORD
' SizeOfDll : DWORD
Declare PtrSafe Function SymLoadModule Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal hFile As LongPtr, _
    ByVal ImageName As String, _
    ByVal ModuleName As String, _
    ByVal BaseOfDll As Long, _
    ByVal SizeOfDll As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymLoadModule = ctypes.windll.dbghelp.SymLoadModule
SymLoadModule.restype = wintypes.DWORD
SymLoadModule.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.HANDLE,  # hFile : HANDLE optional
    wintypes.LPCSTR,  # ImageName : LPCSTR optional
    wintypes.LPCSTR,  # ModuleName : LPCSTR optional
    wintypes.DWORD,  # BaseOfDll : DWORD
    wintypes.DWORD,  # SizeOfDll : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymLoadModule = Fiddle::Function.new(
  lib['SymLoadModule'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE optional
    Fiddle::TYPE_VOIDP,  # ImageName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # ModuleName : LPCSTR optional
    -Fiddle::TYPE_INT,  # BaseOfDll : DWORD
    -Fiddle::TYPE_INT,  # SizeOfDll : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymLoadModule(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        hFile: *mut core::ffi::c_void,  // HANDLE optional
        ImageName: *const u8,  // LPCSTR optional
        ModuleName: *const u8,  // LPCSTR optional
        BaseOfDll: u32,  // DWORD
        SizeOfDll: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern uint SymLoadModule(IntPtr hProcess, IntPtr hFile, [MarshalAs(UnmanagedType.LPStr)] string ImageName, [MarshalAs(UnmanagedType.LPStr)] string ModuleName, uint BaseOfDll, uint SizeOfDll);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymLoadModule' -Namespace Win32 -PassThru
# $api::SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)

#uselib "dbghelp.dll"
#func global SymLoadModule "SymLoadModule" sptr, sptr, sptr, sptr, sptr, sptr
; SymLoadModule hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; hFile : HANDLE optional -> "sptr"
; ImageName : LPCSTR optional -> "sptr"
; ModuleName : LPCSTR optional -> "sptr"
; BaseOfDll : DWORD -> "sptr"
; SizeOfDll : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "dbghelp.dll"
#cfunc global SymLoadModule "SymLoadModule" sptr, sptr, str, str, int, int
; res = SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
; hProcess : HANDLE -> "sptr"
; hFile : HANDLE optional -> "sptr"
; ImageName : LPCSTR optional -> "str"
; ModuleName : LPCSTR optional -> "str"
; BaseOfDll : DWORD -> "int"
; SizeOfDll : DWORD -> "int"

; DWORD SymLoadModule(HANDLE hProcess, HANDLE hFile, LPCSTR ImageName, LPCSTR ModuleName, DWORD BaseOfDll, DWORD SizeOfDll)
#uselib "dbghelp.dll"
#cfunc global SymLoadModule "SymLoadModule" intptr, intptr, str, str, int, int
; res = SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
; hProcess : HANDLE -> "intptr"
; hFile : HANDLE optional -> "intptr"
; ImageName : LPCSTR optional -> "str"
; ModuleName : LPCSTR optional -> "str"
; BaseOfDll : DWORD -> "int"
; SizeOfDll : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymLoadModule = dbghelp.NewProc("SymLoadModule")
)

// hProcess (HANDLE), hFile (HANDLE optional), ImageName (LPCSTR optional), ModuleName (LPCSTR optional), BaseOfDll (DWORD), SizeOfDll (DWORD)
r1, _, err := procSymLoadModule.Call(
	uintptr(hProcess),
	uintptr(hFile),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ImageName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ModuleName))),
	uintptr(BaseOfDll),
	uintptr(SizeOfDll),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function SymLoadModule(
  hProcess: THandle;   // HANDLE
  hFile: THandle;   // HANDLE optional
  ImageName: PAnsiChar;   // LPCSTR optional
  ModuleName: PAnsiChar;   // LPCSTR optional
  BaseOfDll: DWORD;   // DWORD
  SizeOfDll: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'SymLoadModule';

result := DllCall("dbghelp\SymLoadModule"
    , "Ptr", hProcess   ; HANDLE
    , "Ptr", hFile   ; HANDLE optional
    , "AStr", ImageName   ; LPCSTR optional
    , "AStr", ModuleName   ; LPCSTR optional
    , "UInt", BaseOfDll   ; DWORD
    , "UInt", SizeOfDll   ; DWORD
    , "UInt")   ; return: DWORD

●SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll) = DLL("dbghelp.dll", "dword SymLoadModule(void*, void*, char*, char*, dword, dword)")
# 呼び出し: SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
# hProcess : HANDLE -> "void*"
# hFile : HANDLE optional -> "void*"
# ImageName : LPCSTR optional -> "char*"
# ModuleName : LPCSTR optional -> "char*"
# BaseOfDll : DWORD -> "dword"
# SizeOfDll : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "dbghelp" fn SymLoadModule(
    hProcess: ?*anyopaque, // HANDLE
    hFile: ?*anyopaque, // HANDLE optional
    ImageName: [*c]const u8, // LPCSTR optional
    ModuleName: [*c]const u8, // LPCSTR optional
    BaseOfDll: u32, // DWORD
    SizeOfDll: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;

proc SymLoadModule(
    hProcess: pointer,  # HANDLE
    hFile: pointer,  # HANDLE optional
    ImageName: cstring,  # LPCSTR optional
    ModuleName: cstring,  # LPCSTR optional
    BaseOfDll: uint32,  # DWORD
    SizeOfDll: uint32  # DWORD
): uint32 {.importc: "SymLoadModule", stdcall, dynlib: "dbghelp.dll".}

pragma(lib, "dbghelp");
extern(Windows)
uint SymLoadModule(
    void* hProcess,   // HANDLE
    void* hFile,   // HANDLE optional
    const(char)* ImageName,   // LPCSTR optional
    const(char)* ModuleName,   // LPCSTR optional
    uint BaseOfDll,   // DWORD
    uint SizeOfDll   // DWORD
);

ccall((:SymLoadModule, "dbghelp.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Cstring, Cstring, UInt32, UInt32),
      hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
# hProcess : HANDLE -> Ptr{Cvoid}
# hFile : HANDLE optional -> Ptr{Cvoid}
# ImageName : LPCSTR optional -> Cstring
# ModuleName : LPCSTR optional -> Cstring
# BaseOfDll : DWORD -> UInt32
# SizeOfDll : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t SymLoadModule(
    void* hProcess,
    void* hFile,
    const char* ImageName,
    const char* ModuleName,
    uint32_t BaseOfDll,
    uint32_t SizeOfDll);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
-- hProcess : HANDLE
-- hFile : HANDLE optional
-- ImageName : LPCSTR optional
-- ModuleName : LPCSTR optional
-- BaseOfDll : DWORD
-- SizeOfDll : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymLoadModule = lib.func('__stdcall', 'SymLoadModule', 'uint32_t', ['void *', 'void *', 'str', 'str', 'uint32_t', 'uint32_t']);
// SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
// hProcess : HANDLE -> 'void *'
// hFile : HANDLE optional -> 'void *'
// ImageName : LPCSTR optional -> 'str'
// ModuleName : LPCSTR optional -> 'str'
// BaseOfDll : DWORD -> 'uint32_t'
// SizeOfDll : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("dbghelp.dll", {
  SymLoadModule: { parameters: ["pointer", "pointer", "buffer", "buffer", "u32", "u32"], result: "u32" },
});
// lib.symbols.SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll)
// hProcess : HANDLE -> "pointer"
// hFile : HANDLE optional -> "pointer"
// ImageName : LPCSTR optional -> "buffer"
// ModuleName : LPCSTR optional -> "buffer"
// BaseOfDll : DWORD -> "u32"
// SizeOfDll : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t SymLoadModule(
    void* hProcess,
    void* hFile,
    const char* ImageName,
    const char* ModuleName,
    uint32_t BaseOfDll,
    uint32_t SizeOfDll);
C, "dbghelp.dll");
// $ffi->SymLoadModule(hProcess, hFile, ImageName, ModuleName, BaseOfDll, SizeOfDll);
// hProcess : HANDLE
// hFile : HANDLE optional
// ImageName : LPCSTR optional
// ModuleName : LPCSTR optional
// BaseOfDll : DWORD
// SizeOfDll : 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);
    int SymLoadModule(
        Pointer hProcess,   // HANDLE
        Pointer hFile,   // HANDLE optional
        String ImageName,   // LPCSTR optional
        String ModuleName,   // LPCSTR optional
        int BaseOfDll,   // DWORD
        int SizeOfDll   // DWORD
    );
}

@[Link("dbghelp")]
lib Libdbghelp
  fun SymLoadModule = SymLoadModule(
    hProcess : Void*,   # HANDLE
    hFile : Void*,   # HANDLE optional
    ImageName : UInt8*,   # LPCSTR optional
    ModuleName : UInt8*,   # LPCSTR optional
    BaseOfDll : UInt32,   # DWORD
    SizeOfDll : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymLoadModuleNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Uint32);
typedef SymLoadModuleDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int, int);
final SymLoadModule = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymLoadModuleNative, SymLoadModuleDart>('SymLoadModule');
// hProcess : HANDLE -> Pointer<Void>
// hFile : HANDLE optional -> Pointer<Void>
// ImageName : LPCSTR optional -> Pointer<Utf8>
// ModuleName : LPCSTR optional -> Pointer<Utf8>
// BaseOfDll : DWORD -> Uint32
// SizeOfDll : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SymLoadModule(
  hProcess: THandle;   // HANDLE
  hFile: THandle;   // HANDLE optional
  ImageName: PAnsiChar;   // LPCSTR optional
  ModuleName: PAnsiChar;   // LPCSTR optional
  BaseOfDll: DWORD;   // DWORD
  SizeOfDll: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'SymLoadModule';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymLoadModule"
  c_SymLoadModule :: Ptr () -> Ptr () -> CString -> CString -> Word32 -> Word32 -> IO Word32
-- hProcess : HANDLE -> Ptr ()
-- hFile : HANDLE optional -> Ptr ()
-- ImageName : LPCSTR optional -> CString
-- ModuleName : LPCSTR optional -> CString
-- BaseOfDll : DWORD -> Word32
-- SizeOfDll : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let symloadmodule =
  foreign "SymLoadModule"
    ((ptr void) @-> (ptr void) @-> string @-> string @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* hFile : HANDLE optional -> (ptr void) *)
(* ImageName : LPCSTR optional -> string *)
(* ModuleName : LPCSTR optional -> string *)
(* BaseOfDll : DWORD -> uint32_t *)
(* SizeOfDll : 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 ("SymLoadModule" sym-load-module :convention :stdcall) :uint32
  (h-process :pointer)   ; HANDLE
  (h-file :pointer)   ; HANDLE optional
  (image-name :string)   ; LPCSTR optional
  (module-name :string)   ; LPCSTR optional
  (base-of-dll :uint32)   ; DWORD
  (size-of-dll :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SymLoadModule = Win32::API::More->new('dbghelp',
    'DWORD SymLoadModule(HANDLE hProcess, HANDLE hFile, LPCSTR ImageName, LPCSTR ModuleName, DWORD BaseOfDll, DWORD SizeOfDll)');
# my $ret = $SymLoadModule->Call($hProcess, $hFile, $ImageName, $ModuleName, $BaseOfDll, $SizeOfDll);
# hProcess : HANDLE -> HANDLE
# hFile : HANDLE optional -> HANDLE
# ImageName : LPCSTR optional -> LPCSTR
# ModuleName : LPCSTR optional -> LPCSTR
# BaseOfDll : DWORD -> DWORD
# SizeOfDll : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。