: The Win32 exception code (e.g., 0xC0000005 for Access Violation).
// Build a custom comment that gets embedded in the minidump. // This is your chance to add context: which level the player was on, // server load, memory usage, etc. SteamAPI_SetMiniDumpComment( "Minidump comment: SteamworksExample.exe\n" ); // Write and upload the minidump. // The third argument is your own build ID (0 here as a placeholder). // IMPORTANT: Values larger than 10,000,000 cause error reporting to fail. SteamAPI_WriteMiniDump( nExceptionCode, pException, 0 );
// Call WriteMiniDump bool success = steamUtils->WriteMiniDump( 1234, // process ID 5678, // thread ID "C:\\path\\to\\mini_dump.dmp" // file path );
If you are a :
Once implemented, you can view and download crash dumps via the Steamworks Partner Backend. Navigate to to see a categorized list of exceptions, call stacks, and the frequency of each crash. Use tools like WinDbg or Visual Studio to open the .dmp files for debugging.
By invoking this function during an unhandled exception, your game automatically generates a file that you can open in Visual Studio or WinDbg to see the exact line of code that caused the failure. Why Use SteamAPI_WriteMiniDump Instead of Custom Handlers?
void SteamAPI_WriteMiniDump(uint32 uStructuredExceptionCode, void* pvExceptionInfo, uint32 uBuildID) Platform Restriction : This function only supports 32-bit Windows applications. Implementation SteamAPI WriteMiniDump
: A pointer referencing the native Win32 EXCEPTION_POINTERS structure. This structure stores the exact hardware context and exception records needed by debuggers like Visual Studio or WinDbg.
A is a highly compressed file containing the baseline snapshot of a program at its moment of failure. Unlike full memory dumps (which can span gigabytes and contain sensitive user data), a minidump isolates structural runtime parameters. A standard minidump generated by the Steam API contains:
Advanced Guide to SteamAPI_WriteMiniDump: Implementing Robust Crash Reporting in Steamworks : The Win32 exception code (e
SteamAPI_WriteMiniDump is a built-in utility function within the Steamworks API designed to capture user-mode minidumps. A minidump is a compact, lightweight data file containing the foundational diagnostics of a crash. This snapshot typically records: The of active executing threads CPU Register States Structured Exception Codes and memory violation addresses Processor and operating system metadata
Are you seeing this in a specific context (game crash, debug log, reverse engineering)? I can give more targeted advice if you share the surrounding error message.
void SteamAPI_WriteMiniDump( uint32 uStructuredExceptionCode, void* pvExceptionInfo, uint32 uBuildID ); uint32 uBuildID )