IDebugClient5::GetDumpFileWide method (dbgeng.h)

Article
02/22/2024

The GetDumpFileWide method describes the files containing supporting information that were used when opening the current dump target.

Syntax

HRESULT GetDumpFileWide(
  [in]            ULONG    Index,
  [out, optional] PWSTR    Buffer,
  [in]            ULONG    BufferSize,
  [out, optional] PULONG   NameSize,
  [out, optional] PULONG64 Handle,
  [out]           PULONG   Type
);

Parameters

[in] Index

Specifies which file to describe. Index can take values between zero and the number of files minus one; the number of files can be found by using GetNumberDumpFiles.

[out, optional] Buffer

Receives the file name. If Buffer is NULL, this information is not returned.

[in] BufferSize

Specifies the size in characters of the buffer Buffer. This size includes the space for the '\0' terminating character.

[out, optional] NameSize

Receives the size of the file name. This size includes the space for the '\0' terminating character. If NameSize is NULL, this information is not returned.

[out, optional] Handle

Receives the file handle of the file. If Handle is NULL, this information is not returned.

[out] Type

Receives the type of the file.

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

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

Requirements

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