IDebugClient5::AddDumpInformationFileWide method

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(
  PCWSTR  FileName,
  ULONG64 FileHandle,
  ULONG   Type
);

Parameters

FileName

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

FileHandle

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

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

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

See Also

AddDumpInformationFile

GetDumpFile

GetNumberDumpFiles

IDebugClient4

IDebugClient5

OpenDumpFile

OpenDumpFileWide