GetDumpFile

The GetDumpFile and GetDumpFileWide methods describe the files containing supporting information that were used when opening the current dump target.

HRESULT
  IDebugClient4::GetDumpFile(
    IN ULONG  Index,
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  NameSize,
    OUT OPTIONAL PULONG64  Handle,
    OUT PULONG  Type
    );

HRESULT
  IDebugClient4::GetDumpFileWide(
    IN ULONG  Index,
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  NameSize,
    OUT OPTIONAL PULONG64  Handle,
    OUT PULONG  Type
    );

#ifdef UNICODE
#define GetDumpFileT GetDumpFileWide
#else
#define GetDumpFileT GetDumpFile
#endif

Parameters

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.

Buffer

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

BufferSize

Specifies the size in characters of the buffer Buffer.

NameSize

Receives the size of the file name. If NameSize is NULL, this information is not returned.

Handle

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

Type

Receives the type of the file.

Return Value

S_OK

The method was successful.

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

Interface Version

GetDumpFile and GetDumpFileWide are available in IDebugClient4 and later versions.

Comments

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

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

GetNumberDumpFiles, AddDumpInformationFileWide, AddDumpInformationFile