ホーム › System.Diagnostics.Debug › CheckSumMappedFile

CheckSumMappedFile

関数

メモリにマップされたPEファイルのチェックサムを計算する。

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

シグネチャ

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

IMAGE_NT_HEADERS32* CheckSumMappedFile(
    void* BaseAddress,
    DWORD FileLength,
    DWORD* HeaderSum,
    DWORD* CheckSum
);

パラメーター

名前	型	方向	説明
BaseAddress	void*	in	マップされたファイルのベースアドレス。この値は MapViewOfFile 関数を呼び出して取得します。
FileLength	DWORD	in	ファイルのサイズ(バイト単位)。
HeaderSum	DWORD*	out	イメージファイルの元のチェックサムを受け取る変数へのポインター。エラーが発生した場合は 0 になります。
CheckSum	DWORD*	out	計算されたチェックサムを受け取る変数へのポインター。

戻り値の型: IMAGE_NT_HEADERS32*

公式ドキュメント

指定されたイメージファイルのチェックサムを計算します。

戻り値

関数が成功すると、戻り値はマップされたイメージに含まれる IMAGE_NT_HEADERS 構造体へのポインターになります。

関数が失敗すると、戻り値は NULL になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

CheckSumMappedFile 関数はファイルの新しいチェックサムを計算し、CheckSum パラメーターに格納して返します。この関数は、実行可能イメージを作成または変更するアプリケーションで使用されます。チェックサムはカーネルモードドライバーや一部のシステム DLL で必須です。適切なリンカースイッチを使用すると、リンカーはリンク時に元のチェックサムを計算します。詳細については、使用しているリンカーのドキュメントを参照してください。

すべてのイメージは有効なチェックサムを持つことが推奨されます。新しく計算したチェックサムをマップされたイメージに配置し、ファイルのディスク上のイメージを更新するのは、呼び出し側の責任です。

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

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

各言語での呼び出し定義

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

IMAGE_NT_HEADERS32* CheckSumMappedFile(
    void* BaseAddress,
    DWORD FileLength,
    DWORD* HeaderSum,
    DWORD* CheckSum
);

[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CheckSumMappedFile(
    IntPtr BaseAddress,   // void*
    uint FileLength,   // DWORD
    out uint HeaderSum,   // DWORD* out
    out uint CheckSum   // DWORD* out
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CheckSumMappedFile(
    BaseAddress As IntPtr,   ' void*
    FileLength As UInteger,   ' DWORD
    <Out> ByRef HeaderSum As UInteger,   ' DWORD* out
    <Out> ByRef CheckSum As UInteger   ' DWORD* out
) As IntPtr
End Function

' BaseAddress : void*
' FileLength : DWORD
' HeaderSum : DWORD* out
' CheckSum : DWORD* out
Declare PtrSafe Function CheckSumMappedFile Lib "imagehlp" ( _
    ByVal BaseAddress As LongPtr, _
    ByVal FileLength As Long, _
    ByRef HeaderSum As Long, _
    ByRef CheckSum As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CheckSumMappedFile = ctypes.windll.imagehlp.CheckSumMappedFile
CheckSumMappedFile.restype = ctypes.c_void_p
CheckSumMappedFile.argtypes = [
    ctypes.POINTER(None),  # BaseAddress : void*
    wintypes.DWORD,  # FileLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # HeaderSum : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # CheckSum : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
CheckSumMappedFile = Fiddle::Function.new(
  lib['CheckSumMappedFile'],
  [
    Fiddle::TYPE_VOIDP,  # BaseAddress : void*
    -Fiddle::TYPE_INT,  # FileLength : DWORD
    Fiddle::TYPE_VOIDP,  # HeaderSum : DWORD* out
    Fiddle::TYPE_VOIDP,  # CheckSum : DWORD* out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "imagehlp")]
extern "system" {
    fn CheckSumMappedFile(
        BaseAddress: *mut (),  // void*
        FileLength: u32,  // DWORD
        HeaderSum: *mut u32,  // DWORD* out
        CheckSum: *mut u32  // DWORD* out
    ) -> *mut IMAGE_NT_HEADERS32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern IntPtr CheckSumMappedFile(IntPtr BaseAddress, uint FileLength, out uint HeaderSum, out uint CheckSum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_CheckSumMappedFile' -Namespace Win32 -PassThru
# $api::CheckSumMappedFile(BaseAddress, FileLength, HeaderSum, CheckSum)

#uselib "imagehlp.dll"
#func global CheckSumMappedFile "CheckSumMappedFile" sptr, sptr, sptr, sptr
; CheckSumMappedFile BaseAddress, FileLength, varptr(HeaderSum), varptr(CheckSum)   ; 戻り値は stat
; BaseAddress : void* -> "sptr"
; FileLength : DWORD -> "sptr"
; HeaderSum : DWORD* out -> "sptr"
; CheckSum : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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