WerRegisterAppLocalDump function (werapi.h)

Article
07/26/2023

Registers a path (relative to the LocalFolder of the packaged application) where a copy should be saved of the diagnostic memory dump that Windows Error Reporting (WER) collects when one of the processes for the application stops responding.

Syntax

HRESULT WerRegisterAppLocalDump(
  [in] PCWSTR localAppDataRelativePath
);

Parameters

[in] localAppDataRelativePath

The path relative to the local app store for the calling application. This is where a copy is saved of the diagnostic memory dump that WER collects when one of the processes for the application stops responding. The maximum length for this relative path in characters is WER_MAX_LOCAL_DUMP_SUBPATH_LENGTH, which has a value of 64. This maximum length includes the null-termination character.

Return value

This function returns S_OK on success or an error code on failure, including the following error codes.

Return code	Description
WER_E_INVALID_STATE	The process cannot store the memory dump, or WER cannot create a location to store the memory dump.
E_INVALIDARG	The localAppDataRelativePath parameter is NULL or is longer than 64 characters.

Remarks

A packaged application calls WerRegisterAppLocalDump when the application launches to request a copy of the diagnostic memory dump that WER collects if or when one of the processes for the application stops responding.

WER does not manage storage at the location that the relative path specifies or the number of memory dumps that are collected for the application.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1709 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2016 [desktop apps \| UWP apps]
Target Platform	Windows
Header	werapi.h
Library	Kernel32.lib
DLL	KernelBase.dll