Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
plMiniDumpUtils Struct Reference

Functionality for writing process mini-dumps (callstacks, memory snapshots, etc) More...

#include <MiniDumpUtils.h>

Public Types

enum class  plDumpType { Auto , MiniDump , MiniDumpWithFullMemory }
 Specifies the dump mode that is written. More...
 

Static Public Member Functions

static plStatus WriteExternalProcessMiniDump (plStringView sDumpFile, plUInt32 uiProcessID, plDumpType dumpTypeOverride=plDumpType::Auto)
 Tries to write a mini-dump for the external process with the given process ID.
 
static plStatus LaunchMiniDumpTool (plStringView sDumpFile, plDumpType dumpTypeOverride=plDumpType::Auto)
 Tries to launch pl's 'MiniDumpTool' to write a mini-dump for THIS process (the recommended way when an application is crashing).
 

Detailed Description

Functionality for writing process mini-dumps (callstacks, memory snapshots, etc)

Member Enumeration Documentation

◆ plDumpType

enum class plMiniDumpUtils::plDumpType
strong

Specifies the dump mode that is written.

Enumerator
Auto 

Uses the setting specified globally through the command line.

MiniDump 

Saves a mini-dump without full memory, regardless of this application's command line flag '-fullcrashdumps'.

MiniDumpWithFullMemory 

Saves a mini-dump with full memory, regardless of this application's command line flag '-fullcrashdumps'.

Member Function Documentation

◆ LaunchMiniDumpTool()

plStatus plMiniDumpUtils::LaunchMiniDumpTool ( plStringView sDumpFile,
plDumpType dumpTypeOverride = plDumpType::Auto )
static

Tries to launch pl's 'MiniDumpTool' to write a mini-dump for THIS process (the recommended way when an application is crashing).

Note
On Windows: The command line option '-fullcrashdumps' is passed if either set in this application's command line or if overridden through dumpTypeOverride = plDumpType::MiniDumpWithFullMemory.

◆ WriteExternalProcessMiniDump()

PL_FOUNDATION_INTERNAL_HEADER plStatus plMiniDumpUtils::WriteExternalProcessMiniDump ( plStringView sDumpFile,
plUInt32 uiProcessID,
plDumpType dumpTypeOverride = plDumpType::Auto )
static

Tries to write a mini-dump for the external process with the given process ID.

See also
WriteProcessMiniDump()
The documentation for this struct was generated from the following files: