_CrtMemDumpStatistics

Dumps the debug header information for a specified heap state in a user-readable form (debug version only).

Syntax

void _CrtMemDumpStatistics(
   const _CrtMemState *state
);

Parameters

state
Pointer to the heap state to dump.

Remarks

The _CrtMemDumpStatistics function dumps the debug header information for a specified state of the heap in a user-readable form. The dump statistics can be used by the application to track allocations and detect memory problems. The memory state can contain a specific heap state or the difference between two states. When _DEBUG is not defined, calls to _CrtMemDumpStatistics are removed during preprocessing.

The state parameter must be a pointer to a _CrtMemState structure that has been filled in by _CrtMemCheckpoint or returned by _CrtMemDifference before _CrtMemDumpStatistics is called. If state is NULL, the invalid parameter handler is invoked, as described in Parameter Validation. If execution is allowed to continue, errno is set to EINVAL and no action is taken. For more information, see errno, _doserrno, _sys_errlist, and _sys_nerr.

For more information about heap state functions and the _CrtMemState structure, see Heap State Reporting Functions. For more information about how memory blocks are allocated, initialized, and managed in the debug version of the base heap, see CRT Debug Heap Details.

Requirements

Routine Required header Optional headers
_CrtMemDumpStatistics <crtdbg.h> <errno.h>

For more compatibility information, see Compatibility.

Libraries: Debug versions of CRT Library Features only.

See also

Debug Routines