UpdateDebugInfoFileEx function (imagehlp.h)

Article
10/13/2021

Uses the specified extended information to update the corresponding fields in the symbol file.

Note This function works with .dbg files, not .pdb files.

Syntax

BOOL IMAGEAPI UpdateDebugInfoFileEx(
  [in]  PCSTR               ImageFileName,
  [in]  PCSTR               SymbolPath,
  [out] PSTR                DebugFilePath,
  [in]  PIMAGE_NT_HEADERS32 NtHeaders,
  [in]  DWORD               OldCheckSum
);

Parameters

[in] ImageFileName

The name of the image that is now out of date with respect to its symbol file.

[in] SymbolPath

The path in which to look for the symbol file.

[out] DebugFilePath

A pointer to a buffer that receives the name of the symbol file that was updated.

[in] NtHeaders

A pointer to an IMAGE_NT_HEADERS structure that specifies the new header information.

[in] OldCheckSum

The original checksum value. If this value does not match the checksum that is present in the mapped image, the flags in the symbol file contain IMAGE_SEPARATE_DEBUG_MISMATCH and the last error value is set to ERROR_INVALID_DATA.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE.

Remarks

The UpdateDebugInfoFileEx function takes the information stored in the IMAGE_NT_HEADERS structure and updates the corresponding fields in the symbol file. Any time an image file is modified, this function should be called to keep the numbers in sync. Specifically, whenever an image checksum changes, the symbol file should be updated to match.

All ImageHlp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imagehlp.h
Library	Imagehlp.lib
DLL	Imagehlp.dll