WerRegisterExcludedMemoryBlock function (werapi.h)

Article
02/22/2024

Marks a memory block (that is normally included by default in error reports) to be excluded from the Windows Error Reporting (WER) error report.

Syntax

HRESULT WerRegisterExcludedMemoryBlock(
  const void *address,
  DWORD      size
);

Parameters

address

The starting address of the memory block.

size

The size of the memory block, in bytes.

Return value

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

Return code	Description
E_INVALIDARG	address is NULL or size is 0.
E_OUTOFMEMORY	WER could not allocate a large enough heap for the data
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	The number of registered entries exceeds the limit (WER_MAX_REGISTERED_ENTRIES).
WER_E_INVALID_STATE	The process state is not valid. For example, the process is in application recovery mode.

Remarks

This mechanism is intended for applications that hold large amounts of data in memory that aren't useful for root cause debugging and increase the size of the dump file unnecessarily. For example, some games hold large amounts of texture data in memory that is included in error dumps by default.

Requirements

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