ホーム › System.Diagnostics.Debug › SymGetSourceFileChecksum

SymGetSourceFileChecksum

関数

ソースファイルのチェックサムを取得する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymGetSourceFileChecksum(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR FileSpec,
    DWORD* pCheckSumType,
    BYTE* pChecksum,
    DWORD checksumSize,
    DWORD* pActualBytesWritten
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
Base	ULONGLONG	in	モジュールのベースアドレス。
FileSpec	LPCSTR	in	ソースファイルの名前。
pCheckSumType	DWORD*	out	成功した場合、チェックサムの種類を指します。
pChecksum	BYTE*	out	チェックサムを受け取るバッファーへのポインター。NULL の場合、呼び出しが返るときに pActualBytesWritten が必要なバイト数を返します。
checksumSize	DWORD	in	pChecksum バッファーのサイズ (バイト単位)。
pActualBytesWritten	DWORD*	out	バッファーに実際に書き込まれたバイト数へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymGetSourceFileChecksum 関数 (dbghelp.h) は、指定したソースファイルのチェックサムをソースサーバーから取得します。

戻り値

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

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

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

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymGetSourceFileChecksum(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR FileSpec,
    DWORD* pCheckSumType,
    BYTE* pChecksum,
    DWORD checksumSize,
    DWORD* pActualBytesWritten
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSourceFileChecksum(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPStr)] string FileSpec,   // LPCSTR
    out uint pCheckSumType,   // DWORD* out
    IntPtr pChecksum,   // BYTE* out
    uint checksumSize,   // DWORD
    out uint pActualBytesWritten   // DWORD* out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSourceFileChecksum(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPStr)> FileSpec As String,   ' LPCSTR
    <Out> ByRef pCheckSumType As UInteger,   ' DWORD* out
    pChecksum As IntPtr,   ' BYTE* out
    checksumSize As UInteger,   ' DWORD
    <Out> ByRef pActualBytesWritten As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' Base : ULONGLONG
' FileSpec : LPCSTR
' pCheckSumType : DWORD* out
' pChecksum : BYTE* out
' checksumSize : DWORD
' pActualBytesWritten : DWORD* out
Declare PtrSafe Function SymGetSourceFileChecksum Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal FileSpec As String, _
    ByRef pCheckSumType As Long, _
    ByVal pChecksum As LongPtr, _
    ByVal checksumSize As Long, _
    ByRef pActualBytesWritten As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetSourceFileChecksum = ctypes.windll.dbghelp.SymGetSourceFileChecksum
SymGetSourceFileChecksum.restype = wintypes.BOOL
SymGetSourceFileChecksum.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCSTR,  # FileSpec : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pCheckSumType : DWORD* out
    ctypes.POINTER(ctypes.c_ubyte),  # pChecksum : BYTE* out
    wintypes.DWORD,  # checksumSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pActualBytesWritten : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSourceFileChecksum = Fiddle::Function.new(
  lib['SymGetSourceFileChecksum'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    Fiddle::TYPE_VOIDP,  # FileSpec : LPCSTR
    Fiddle::TYPE_VOIDP,  # pCheckSumType : DWORD* out
    Fiddle::TYPE_VOIDP,  # pChecksum : BYTE* out
    -Fiddle::TYPE_INT,  # checksumSize : DWORD
    Fiddle::TYPE_VOIDP,  # pActualBytesWritten : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceFileChecksum(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        FileSpec: *const u8,  // LPCSTR
        pCheckSumType: *mut u32,  // DWORD* out
        pChecksum: *mut u8,  // BYTE* out
        checksumSize: u32,  // DWORD
        pActualBytesWritten: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SymGetSourceFileChecksum(IntPtr hProcess, ulong Base, [MarshalAs(UnmanagedType.LPStr)] string FileSpec, out uint pCheckSumType, IntPtr pChecksum, uint checksumSize, out uint pActualBytesWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceFileChecksum' -Namespace Win32 -PassThru
# $api::SymGetSourceFileChecksum(hProcess, Base, FileSpec, pCheckSumType, pChecksum, checksumSize, pActualBytesWritten)

#uselib "dbghelp.dll"
#func global SymGetSourceFileChecksum "SymGetSourceFileChecksum" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SymGetSourceFileChecksum hProcess, Base, FileSpec, varptr(pCheckSumType), varptr(pChecksum), checksumSize, varptr(pActualBytesWritten)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "sptr"
; FileSpec : LPCSTR -> "sptr"
; pCheckSumType : DWORD* out -> "sptr"
; pChecksum : BYTE* out -> "sptr"
; checksumSize : DWORD -> "sptr"
; pActualBytesWritten : DWORD* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileChecksum "SymGetSourceFileChecksum" sptr, int64, str, var, var, int, var
; res = SymGetSourceFileChecksum(hProcess, Base, FileSpec, pCheckSumType, pChecksum, checksumSize, pActualBytesWritten)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCSTR -> "str"
; pCheckSumType : DWORD* out -> "var"
; pChecksum : BYTE* out -> "var"
; checksumSize : DWORD -> "int"
; pActualBytesWritten : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileChecksum "SymGetSourceFileChecksum" sptr, int64, str, sptr, sptr, int, sptr
; res = SymGetSourceFileChecksum(hProcess, Base, FileSpec, varptr(pCheckSumType), varptr(pChecksum), checksumSize, varptr(pActualBytesWritten))
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCSTR -> "str"
; pCheckSumType : DWORD* out -> "sptr"
; pChecksum : BYTE* out -> "sptr"
; checksumSize : DWORD -> "int"
; pActualBytesWritten : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。