ホーム › System.Diagnostics.Debug › ImageUnload

ImageUnload

関数

ImageLoadで読み込んだイメージを解放する。

DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ImageUnload(
    LOADED_IMAGE* LoadedImage
);

パラメーター

名前	型	方向	説明
LoadedImage	LOADED_IMAGE*	inout	ImageLoad 関数の呼び出しから返された LOADED_IMAGE 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ImageLoad 関数の前回の呼び出しによって確保されたリソースを解放します。

戻り値

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

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

ImageLoad と ImageUnload は内部データを共有しており、ImageLoad を連続して複数回呼び出すとそのデータが破損する可能性があります。したがって、ImageUnload を呼び出す前に ImageLoad を 1 回だけ呼び出していることを確認してください。

解説(Remarks)

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

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

各言語での呼び出し定義

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

BOOL ImageUnload(
    LOADED_IMAGE* LoadedImage
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ImageUnload(
    IntPtr LoadedImage   // LOADED_IMAGE* in/out
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ImageUnload(
    LoadedImage As IntPtr   ' LOADED_IMAGE* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' LoadedImage : LOADED_IMAGE* in/out
Declare PtrSafe Function ImageUnload Lib "imagehlp" ( _
    ByVal LoadedImage As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImageUnload = ctypes.windll.imagehlp.ImageUnload
ImageUnload.restype = wintypes.BOOL
ImageUnload.argtypes = [
    ctypes.c_void_p,  # LoadedImage : LOADED_IMAGE* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
ImageUnload = Fiddle::Function.new(
  lib['ImageUnload'],
  [
    Fiddle::TYPE_VOIDP,  # LoadedImage : LOADED_IMAGE* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "imagehlp")]
extern "system" {
    fn ImageUnload(
        LoadedImage: *mut LOADED_IMAGE  // LOADED_IMAGE* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern bool ImageUnload(IntPtr LoadedImage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_ImageUnload' -Namespace Win32 -PassThru
# $api::ImageUnload(LoadedImage)

#uselib "imagehlp.dll"
#func global ImageUnload "ImageUnload" sptr
; ImageUnload varptr(LoadedImage)   ; 戻り値は stat
; LoadedImage : LOADED_IMAGE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "imagehlp.dll"
#cfunc global ImageUnload "ImageUnload" var
; res = ImageUnload(LoadedImage)
; LoadedImage : LOADED_IMAGE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "imagehlp.dll"
#cfunc global ImageUnload "ImageUnload" sptr
; res = ImageUnload(varptr(LoadedImage))
; LoadedImage : LOADED_IMAGE* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。