Collects a full snapshot and provides the name of the snapshot.

Namespace:  SciTech.NetMemProfiler
Assembly:  MemProfiler2 (in MemProfiler2.dll)

Syntax

C#
public static MemSnapShot FullSnapShot(
	string snapShotName
)
Visual Basic
Public Shared Function FullSnapShot ( _
	snapShotName As String _
) As MemSnapShot
Visual C++
public:
static MemSnapShot FullSnapShot(
	String^ snapShotName
)

Parameters

snapShotName
Type: System..::..String
Defines the name of the snapshot. This name will be used when .NET Memory Profiler saves the snapshot.

Return Value

If profiling is active, a MemSnapShot instance representing the current state of the garbage collected heap. Otherwise Empty will be returned.

Examples

Copy CodeC#
void ReportHeapStatus()
{
    // Collect a full heap snapshot that can be analysed using .NET Memory Profiler.
    MemProfiler.FullSnapShot( "My automatically report snapshot" ); 
}

See Also