IDebugClient5::AddDumpInformationFileWide method (dbgeng.h)

Article
02/22/2024

The AddDumpInformationFileWide method registers additional files containing supporting information that will be used when opening a dump file. The ASCII version of this method is AddDumpInformationFile.

Syntax

HRESULT AddDumpInformationFileWide(
  [in, optional] PCWSTR  FileName,
  [in]           ULONG64 FileHandle,
  [in]           ULONG   Type
);

Parameters

[in, optional] FileName

Specifies the name of the file containing the supporting information. If FileHandle is not zero, FileName is used only for informational purposes.

[in] FileHandle

Specifies the handle of the file containing the supporting information. If FileHandle is zero, the file named in FileName is used.

[in] Type

Specifies the type of the file in FileName or FileHandle. Currently, only files containing paging file information are supported, and Type must be set to DEBUG_DUMP_FILE_PAGE_FILE_DUMP.

Return value

This method may also return error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.

Remarks

If supporting information is to be used when opening a dump file, this method or AddDumpInformationFile must be called before OpenDumpFile is called. If a session has already started, this method cannot be used.

For more information about crash dump files, see Dump-File Targets.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)