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

SymUnloadModule

関数
読み込み済みモジュールのシンボルを解放する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymUnloadModule(
    HANDLE hProcess,
    DWORD BaseOfDll
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスのハンドル。
BaseOfDllDWORDinアンロードするモジュールのベースアドレス。

戻り値の型: BOOL

公式ドキュメント

シンボルテーブルをアンロードします。(SymUnloadModule)

戻り値

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

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

解説(Remarks)

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

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymUnloadModule SymUnloadModule64
#else
BOOL
IMAGEAPI
SymUnloadModule(
    __in HANDLE hProcess,
    __in DWORD BaseOfDll
    );
#endif

例については、 Unloading a Symbol Module を参照してください。

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

各言語での呼び出し定義

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

BOOL SymUnloadModule(
    HANDLE hProcess,
    DWORD BaseOfDll
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymUnloadModule(
    IntPtr hProcess,   // HANDLE
    uint BaseOfDll   // DWORD
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymUnloadModule(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' BaseOfDll : DWORD
Declare PtrSafe Function SymUnloadModule Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymUnloadModule = ctypes.windll.dbghelp.SymUnloadModule
SymUnloadModule.restype = wintypes.BOOL
SymUnloadModule.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # BaseOfDll : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymUnloadModule = Fiddle::Function.new(
  lib['SymUnloadModule'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # BaseOfDll : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymUnloadModule(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u32  // DWORD
    ) -> 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 SymUnloadModule(IntPtr hProcess, uint BaseOfDll);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymUnloadModule' -Namespace Win32 -PassThru
# $api::SymUnloadModule(hProcess, BaseOfDll)
#uselib "dbghelp.dll"
#func global SymUnloadModule "SymUnloadModule" sptr, sptr
; SymUnloadModule hProcess, BaseOfDll   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; BaseOfDll : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymUnloadModule "SymUnloadModule" sptr, int
; res = SymUnloadModule(hProcess, BaseOfDll)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : DWORD -> "int"
; BOOL SymUnloadModule(HANDLE hProcess, DWORD BaseOfDll)
#uselib "dbghelp.dll"
#cfunc global SymUnloadModule "SymUnloadModule" intptr, int
; res = SymUnloadModule(hProcess, BaseOfDll)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymUnloadModule = dbghelp.NewProc("SymUnloadModule")
)

// hProcess (HANDLE), BaseOfDll (DWORD)
r1, _, err := procSymUnloadModule.Call(
	uintptr(hProcess),
	uintptr(BaseOfDll),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymUnloadModule(
  hProcess: THandle;   // HANDLE
  BaseOfDll: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymUnloadModule';
result := DllCall("dbghelp\SymUnloadModule"
    , "Ptr", hProcess   ; HANDLE
    , "UInt", BaseOfDll   ; DWORD
    , "Int")   ; return: BOOL
●SymUnloadModule(hProcess, BaseOfDll) = DLL("dbghelp.dll", "bool SymUnloadModule(void*, dword)")
# 呼び出し: SymUnloadModule(hProcess, BaseOfDll)
# hProcess : HANDLE -> "void*"
# BaseOfDll : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymUnloadModule(
    hProcess: ?*anyopaque, // HANDLE
    BaseOfDll: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SymUnloadModule(
    hProcess: pointer,  # HANDLE
    BaseOfDll: uint32  # DWORD
): int32 {.importc: "SymUnloadModule", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymUnloadModule(
    void* hProcess,   // HANDLE
    uint BaseOfDll   // DWORD
);
ccall((:SymUnloadModule, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      hProcess, BaseOfDll)
# hProcess : HANDLE -> Ptr{Cvoid}
# BaseOfDll : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymUnloadModule(
    void* hProcess,
    uint32_t BaseOfDll);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymUnloadModule(hProcess, BaseOfDll)
-- hProcess : HANDLE
-- BaseOfDll : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymUnloadModule = lib.func('__stdcall', 'SymUnloadModule', 'int32_t', ['void *', 'uint32_t']);
// SymUnloadModule(hProcess, BaseOfDll)
// hProcess : HANDLE -> 'void *'
// BaseOfDll : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymUnloadModule: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.SymUnloadModule(hProcess, BaseOfDll)
// hProcess : HANDLE -> "pointer"
// BaseOfDll : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymUnloadModule(
    void* hProcess,
    uint32_t BaseOfDll);
C, "dbghelp.dll");
// $ffi->SymUnloadModule(hProcess, BaseOfDll);
// hProcess : HANDLE
// BaseOfDll : 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);
    boolean SymUnloadModule(
        Pointer hProcess,   // HANDLE
        int BaseOfDll   // DWORD
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymUnloadModule = SymUnloadModule(
    hProcess : Void*,   # HANDLE
    BaseOfDll : 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 SymUnloadModuleNative = Int32 Function(Pointer<Void>, Uint32);
typedef SymUnloadModuleDart = int Function(Pointer<Void>, int);
final SymUnloadModule = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymUnloadModuleNative, SymUnloadModuleDart>('SymUnloadModule');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymUnloadModule(
  hProcess: THandle;   // HANDLE
  BaseOfDll: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymUnloadModule';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymUnloadModule"
  c_SymUnloadModule :: Ptr () -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- BaseOfDll : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symunloadmodule =
  foreign "SymUnloadModule"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* BaseOfDll : 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 ("SymUnloadModule" sym-unload-module :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base-of-dll :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymUnloadModule = Win32::API::More->new('dbghelp',
    'BOOL SymUnloadModule(HANDLE hProcess, DWORD BaseOfDll)');
# my $ret = $SymUnloadModule->Call($hProcess, $BaseOfDll);
# hProcess : HANDLE -> HANDLE
# BaseOfDll : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目