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

UpdateDebugInfoFile

関数
イメージのデバッグ情報ファイルを更新する。
DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL UpdateDebugInfoFile(
    LPCSTR ImageFileName,
    LPCSTR SymbolPath,
    LPSTR DebugFilePath,
    IMAGE_NT_HEADERS32* NtHeaders
);

パラメーター

名前方向説明
ImageFileNameLPCSTRinシンボルファイルに対して現在内容が古くなっているイメージの名前。
SymbolPathLPCSTRinシンボルファイルを検索するパス。
DebugFilePathLPSTRout更新されたシンボルファイルの名前を受け取るバッファーへのポインター。
NtHeadersIMAGE_NT_HEADERS32*in新しいヘッダー情報を指定する IMAGE_NT_HEADERS 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定された情報を使用して、シンボルファイル内の対応するフィールドを更新します。

戻り値

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

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

解説(Remarks)

UpdateDebugInfoFile 関数は、 IMAGE_NT_HEADERS 構造体に格納されている情報を取得し、シンボルファイル内の対応するフィールドを更新します。イメージファイルが変更されたときは常に、シンボルファイル内の値を同期させるためにこの関数を呼び出す必要があります。具体的には、イメージのチェックサムが変更されるたびに、それに一致するようシンボルファイルを更新する必要があります。

この関数を含むすべての 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 UpdateDebugInfoFile(
    LPCSTR ImageFileName,
    LPCSTR SymbolPath,
    LPSTR DebugFilePath,
    IMAGE_NT_HEADERS32* NtHeaders
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UpdateDebugInfoFile(
    [MarshalAs(UnmanagedType.LPStr)] string ImageFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder DebugFilePath,   // LPSTR out
    IntPtr NtHeaders   // IMAGE_NT_HEADERS32*
);
<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UpdateDebugInfoFile(
    <MarshalAs(UnmanagedType.LPStr)> ImageFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> DebugFilePath As System.Text.StringBuilder,   ' LPSTR out
    NtHeaders As IntPtr   ' IMAGE_NT_HEADERS32*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ImageFileName : LPCSTR
' SymbolPath : LPCSTR
' DebugFilePath : LPSTR out
' NtHeaders : IMAGE_NT_HEADERS32*
Declare PtrSafe Function UpdateDebugInfoFile Lib "imagehlp" ( _
    ByVal ImageFileName As String, _
    ByVal SymbolPath As String, _
    ByVal DebugFilePath As String, _
    ByVal NtHeaders As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UpdateDebugInfoFile = ctypes.windll.imagehlp.UpdateDebugInfoFile
UpdateDebugInfoFile.restype = wintypes.BOOL
UpdateDebugInfoFile.argtypes = [
    wintypes.LPCSTR,  # ImageFileName : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : LPCSTR
    wintypes.LPSTR,  # DebugFilePath : LPSTR out
    ctypes.c_void_p,  # NtHeaders : IMAGE_NT_HEADERS32*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
UpdateDebugInfoFile = Fiddle::Function.new(
  lib['UpdateDebugInfoFile'],
  [
    Fiddle::TYPE_VOIDP,  # ImageFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # DebugFilePath : LPSTR out
    Fiddle::TYPE_VOIDP,  # NtHeaders : IMAGE_NT_HEADERS32*
  ],
  Fiddle::TYPE_INT)
#[link(name = "imagehlp")]
extern "system" {
    fn UpdateDebugInfoFile(
        ImageFileName: *const u8,  // LPCSTR
        SymbolPath: *const u8,  // LPCSTR
        DebugFilePath: *mut u8,  // LPSTR out
        NtHeaders: *mut IMAGE_NT_HEADERS32  // IMAGE_NT_HEADERS32*
    ) -> 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 UpdateDebugInfoFile([MarshalAs(UnmanagedType.LPStr)] string ImageFileName, [MarshalAs(UnmanagedType.LPStr)] string SymbolPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder DebugFilePath, IntPtr NtHeaders);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_UpdateDebugInfoFile' -Namespace Win32 -PassThru
# $api::UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
#uselib "imagehlp.dll"
#func global UpdateDebugInfoFile "UpdateDebugInfoFile" sptr, sptr, sptr, sptr
; UpdateDebugInfoFile ImageFileName, SymbolPath, varptr(DebugFilePath), varptr(NtHeaders)   ; 戻り値は stat
; ImageFileName : LPCSTR -> "sptr"
; SymbolPath : LPCSTR -> "sptr"
; DebugFilePath : LPSTR out -> "sptr"
; NtHeaders : IMAGE_NT_HEADERS32* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "imagehlp.dll"
#cfunc global UpdateDebugInfoFile "UpdateDebugInfoFile" str, str, var, var
; res = UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
; ImageFileName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; DebugFilePath : LPSTR out -> "var"
; NtHeaders : IMAGE_NT_HEADERS32* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL UpdateDebugInfoFile(LPCSTR ImageFileName, LPCSTR SymbolPath, LPSTR DebugFilePath, IMAGE_NT_HEADERS32* NtHeaders)
#uselib "imagehlp.dll"
#cfunc global UpdateDebugInfoFile "UpdateDebugInfoFile" str, str, var, var
; res = UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
; ImageFileName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; DebugFilePath : LPSTR out -> "var"
; NtHeaders : IMAGE_NT_HEADERS32* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imagehlp = windows.NewLazySystemDLL("imagehlp.dll")
	procUpdateDebugInfoFile = imagehlp.NewProc("UpdateDebugInfoFile")
)

// ImageFileName (LPCSTR), SymbolPath (LPCSTR), DebugFilePath (LPSTR out), NtHeaders (IMAGE_NT_HEADERS32*)
r1, _, err := procUpdateDebugInfoFile.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ImageFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SymbolPath))),
	uintptr(DebugFilePath),
	uintptr(NtHeaders),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UpdateDebugInfoFile(
  ImageFileName: PAnsiChar;   // LPCSTR
  SymbolPath: PAnsiChar;   // LPCSTR
  DebugFilePath: PAnsiChar;   // LPSTR out
  NtHeaders: Pointer   // IMAGE_NT_HEADERS32*
): BOOL; stdcall;
  external 'imagehlp.dll' name 'UpdateDebugInfoFile';
result := DllCall("imagehlp\UpdateDebugInfoFile"
    , "AStr", ImageFileName   ; LPCSTR
    , "AStr", SymbolPath   ; LPCSTR
    , "Ptr", DebugFilePath   ; LPSTR out
    , "Ptr", NtHeaders   ; IMAGE_NT_HEADERS32*
    , "Int")   ; return: BOOL
●UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders) = DLL("imagehlp.dll", "bool UpdateDebugInfoFile(char*, char*, char*, void*)")
# 呼び出し: UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
# ImageFileName : LPCSTR -> "char*"
# SymbolPath : LPCSTR -> "char*"
# DebugFilePath : LPSTR out -> "char*"
# NtHeaders : IMAGE_NT_HEADERS32* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imagehlp" fn UpdateDebugInfoFile(
    ImageFileName: [*c]const u8, // LPCSTR
    SymbolPath: [*c]const u8, // LPCSTR
    DebugFilePath: [*c]u8, // LPSTR out
    NtHeaders: [*c]IMAGE_NT_HEADERS32 // IMAGE_NT_HEADERS32*
) callconv(std.os.windows.WINAPI) i32;
proc UpdateDebugInfoFile(
    ImageFileName: cstring,  # LPCSTR
    SymbolPath: cstring,  # LPCSTR
    DebugFilePath: ptr char,  # LPSTR out
    NtHeaders: ptr IMAGE_NT_HEADERS32  # IMAGE_NT_HEADERS32*
): int32 {.importc: "UpdateDebugInfoFile", stdcall, dynlib: "imagehlp.dll".}
pragma(lib, "imagehlp");
extern(Windows)
int UpdateDebugInfoFile(
    const(char)* ImageFileName,   // LPCSTR
    const(char)* SymbolPath,   // LPCSTR
    char* DebugFilePath,   // LPSTR out
    IMAGE_NT_HEADERS32* NtHeaders   // IMAGE_NT_HEADERS32*
);
ccall((:UpdateDebugInfoFile, "imagehlp.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{UInt8}, Ptr{IMAGE_NT_HEADERS32}),
      ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
# ImageFileName : LPCSTR -> Cstring
# SymbolPath : LPCSTR -> Cstring
# DebugFilePath : LPSTR out -> Ptr{UInt8}
# NtHeaders : IMAGE_NT_HEADERS32* -> Ptr{IMAGE_NT_HEADERS32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UpdateDebugInfoFile(
    const char* ImageFileName,
    const char* SymbolPath,
    char* DebugFilePath,
    void* NtHeaders);
]]
local imagehlp = ffi.load("imagehlp")
-- imagehlp.UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
-- ImageFileName : LPCSTR
-- SymbolPath : LPCSTR
-- DebugFilePath : LPSTR out
-- NtHeaders : IMAGE_NT_HEADERS32*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('imagehlp.dll');
const UpdateDebugInfoFile = lib.func('__stdcall', 'UpdateDebugInfoFile', 'int32_t', ['str', 'str', 'char *', 'void *']);
// UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
// ImageFileName : LPCSTR -> 'str'
// SymbolPath : LPCSTR -> 'str'
// DebugFilePath : LPSTR out -> 'char *'
// NtHeaders : IMAGE_NT_HEADERS32* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("imagehlp.dll", {
  UpdateDebugInfoFile: { parameters: ["buffer", "buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders)
// ImageFileName : LPCSTR -> "buffer"
// SymbolPath : LPCSTR -> "buffer"
// DebugFilePath : LPSTR out -> "buffer"
// NtHeaders : IMAGE_NT_HEADERS32* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UpdateDebugInfoFile(
    const char* ImageFileName,
    const char* SymbolPath,
    char* DebugFilePath,
    void* NtHeaders);
C, "imagehlp.dll");
// $ffi->UpdateDebugInfoFile(ImageFileName, SymbolPath, DebugFilePath, NtHeaders);
// ImageFileName : LPCSTR
// SymbolPath : LPCSTR
// DebugFilePath : LPSTR out
// NtHeaders : IMAGE_NT_HEADERS32*
// 構造体/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 Imagehlp extends StdCallLibrary {
    Imagehlp INSTANCE = Native.load("imagehlp", Imagehlp.class);
    boolean UpdateDebugInfoFile(
        String ImageFileName,   // LPCSTR
        String SymbolPath,   // LPCSTR
        byte[] DebugFilePath,   // LPSTR out
        Pointer NtHeaders   // IMAGE_NT_HEADERS32*
    );
}
@[Link("imagehlp")]
lib Libimagehlp
  fun UpdateDebugInfoFile = UpdateDebugInfoFile(
    ImageFileName : UInt8*,   # LPCSTR
    SymbolPath : UInt8*,   # LPCSTR
    DebugFilePath : UInt8*,   # LPSTR out
    NtHeaders : IMAGE_NT_HEADERS32*   # IMAGE_NT_HEADERS32*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UpdateDebugInfoFileNative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
typedef UpdateDebugInfoFileDart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
final UpdateDebugInfoFile = DynamicLibrary.open('imagehlp.dll')
    .lookupFunction<UpdateDebugInfoFileNative, UpdateDebugInfoFileDart>('UpdateDebugInfoFile');
// ImageFileName : LPCSTR -> Pointer<Utf8>
// SymbolPath : LPCSTR -> Pointer<Utf8>
// DebugFilePath : LPSTR out -> Pointer<Utf8>
// NtHeaders : IMAGE_NT_HEADERS32* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UpdateDebugInfoFile(
  ImageFileName: PAnsiChar;   // LPCSTR
  SymbolPath: PAnsiChar;   // LPCSTR
  DebugFilePath: PAnsiChar;   // LPSTR out
  NtHeaders: Pointer   // IMAGE_NT_HEADERS32*
): BOOL; stdcall;
  external 'imagehlp.dll' name 'UpdateDebugInfoFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UpdateDebugInfoFile"
  c_UpdateDebugInfoFile :: CString -> CString -> CString -> Ptr () -> IO CInt
-- ImageFileName : LPCSTR -> CString
-- SymbolPath : LPCSTR -> CString
-- DebugFilePath : LPSTR out -> CString
-- NtHeaders : IMAGE_NT_HEADERS32* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let updatedebuginfofile =
  foreign "UpdateDebugInfoFile"
    (string @-> string @-> string @-> (ptr void) @-> returning int32_t)
(* ImageFileName : LPCSTR -> string *)
(* SymbolPath : LPCSTR -> string *)
(* DebugFilePath : LPSTR out -> string *)
(* NtHeaders : IMAGE_NT_HEADERS32* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imagehlp (t "imagehlp.dll"))
(cffi:use-foreign-library imagehlp)

(cffi:defcfun ("UpdateDebugInfoFile" update-debug-info-file :convention :stdcall) :int32
  (image-file-name :string)   ; LPCSTR
  (symbol-path :string)   ; LPCSTR
  (debug-file-path :pointer)   ; LPSTR out
  (nt-headers :pointer))   ; IMAGE_NT_HEADERS32*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UpdateDebugInfoFile = Win32::API::More->new('imagehlp',
    'BOOL UpdateDebugInfoFile(LPCSTR ImageFileName, LPCSTR SymbolPath, LPSTR DebugFilePath, LPVOID NtHeaders)');
# my $ret = $UpdateDebugInfoFile->Call($ImageFileName, $SymbolPath, $DebugFilePath, $NtHeaders);
# ImageFileName : LPCSTR -> LPCSTR
# SymbolPath : LPCSTR -> LPCSTR
# DebugFilePath : LPSTR out -> LPSTR
# NtHeaders : IMAGE_NT_HEADERS32* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型