ホーム › System.Diagnostics.Debug › MapFileAndCheckSumW

MapFileAndCheckSumW

関数

ファイルをマップしチェックサムを計算する。

DLLimagehlp.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// imagehlp.dll  (Unicode / -W)
#include <windows.h>

DWORD MapFileAndCheckSumW(
    LPCWSTR Filename,
    DWORD* HeaderSum,
    DWORD* CheckSum
);

パラメーター

名前	型	方向	説明
Filename	LPCWSTR	in	チェックサムを計算する対象ファイルのファイル名。
HeaderSum	DWORD*	out	イメージファイルから取得した元のチェックサムを受け取る変数へのポインター。エラーが発生した場合は 0 を受け取ります。
CheckSum	DWORD*	out	計算されたチェックサムを受け取る変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

指定したファイルのチェックサムを計算します。(Unicode)

戻り値

関数が成功した場合、戻り値は CHECKSUM_SUCCESS (0) です。

関数が失敗した場合、戻り値は以下のいずれかになります。

戻り値/値	説明
CHECKSUM_MAP_FAILURE 2	ファイルをマップできませんでした。
CHECKSUM_MAPVIEW_FAILURE 3	ファイルのビューをマップできませんでした。
CHECKSUM_OPEN_FAILURE 1	ファイルを開けませんでした。
CHECKSUM_UNICODE_FAILURE 4	ファイル名を Unicode に変換できませんでした。

解説(Remarks)

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

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

有効な実行可能イメージを指していない Filename パラメーターを渡すと、予測できない結果が生じます。この関数を使用する場合は、有効な実行可能イメージが渡されていることを必ず確認してください。

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

注意この関数の Unicode 実装は ASCII 実装を呼び出すため、コードページがパス内の文字をサポートしていない場合、関数が失敗することがあります。たとえば、英語以外の Unicode ファイルパスを渡し、既定のコードページが英語の場合、認識されない英語以外のワイド文字は "??" に変換され、ファイルを開けなくなります(関数は CHECKSUM_OPEN_FAILURE を返します)。

メモ

imagehlp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MapFileAndCheckSum を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// imagehlp.dll  (Unicode / -W)
#include <windows.h>

DWORD MapFileAndCheckSumW(
    LPCWSTR Filename,
    DWORD* HeaderSum,
    DWORD* CheckSum
);

[DllImport("imagehlp.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MapFileAndCheckSumW(
    [MarshalAs(UnmanagedType.LPWStr)] string Filename,   // LPCWSTR
    out uint HeaderSum,   // DWORD* out
    out uint CheckSum   // DWORD* out
);

<DllImport("imagehlp.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MapFileAndCheckSumW(
    <MarshalAs(UnmanagedType.LPWStr)> Filename As String,   ' LPCWSTR
    <Out> ByRef HeaderSum As UInteger,   ' DWORD* out
    <Out> ByRef CheckSum As UInteger   ' DWORD* out
) As UInteger
End Function

' Filename : LPCWSTR
' HeaderSum : DWORD* out
' CheckSum : DWORD* out
Declare PtrSafe Function MapFileAndCheckSumW Lib "imagehlp" ( _
    ByVal Filename As LongPtr, _
    ByRef HeaderSum As Long, _
    ByRef CheckSum As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MapFileAndCheckSumW = ctypes.windll.imagehlp.MapFileAndCheckSumW
MapFileAndCheckSumW.restype = wintypes.DWORD
MapFileAndCheckSumW.argtypes = [
    wintypes.LPCWSTR,  # Filename : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # HeaderSum : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # CheckSum : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
MapFileAndCheckSumW = Fiddle::Function.new(
  lib['MapFileAndCheckSumW'],
  [
    Fiddle::TYPE_VOIDP,  # Filename : LPCWSTR
    Fiddle::TYPE_VOIDP,  # HeaderSum : DWORD* out
    Fiddle::TYPE_VOIDP,  # CheckSum : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "imagehlp")]
extern "system" {
    fn MapFileAndCheckSumW(
        Filename: *const u16,  // LPCWSTR
        HeaderSum: *mut u32,  // DWORD* out
        CheckSum: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("imagehlp.dll", CharSet = CharSet.Unicode)]
public static extern uint MapFileAndCheckSumW([MarshalAs(UnmanagedType.LPWStr)] string Filename, out uint HeaderSum, out uint CheckSum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_MapFileAndCheckSumW' -Namespace Win32 -PassThru
# $api::MapFileAndCheckSumW(Filename, HeaderSum, CheckSum)

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

出力引数:

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