Export (0) Print
Expand All

GC.Collect Method (Int32, GCCollectionMode)

Forces a garbage collection from generation zero through a specified generation, at a time specified by a GCCollectionMode value.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public static function Collect(
	generation : int, 
	mode : GCCollectionMode
)

Parameters

generation
Type: System.Int32

The number of the oldest generation that garbage collection can be performed on.

mode
Type: System.GCCollectionMode

One of the GCCollectionMode values.

ExceptionCondition
ArgumentOutOfRangeException

generation is not valid.

-or-

mode is not one of the GCCollectionMode values.

Use the mode parameter to specify whether garbage collection should occur immediately or only if the time is optimal to reclaim objects. Using this method does not guarantee that all inaccessible memory in the specified generation is reclaimed.

To adjust the intrusiveness of garbage collection during critical periods in your application, set the LatencyMode property.

The garbage collector does not collect objects with a generation number higher than specified by the generation parameter. Use the MaxGeneration property to determine the maximum valid value of generation.

To have the garbage collector consider all objects regardless of their generation, use the version of this method that takes no parameters.

To have the garbage collector reclaim objects up to a specified generation of objects, use the GC.Collect(Int32) method overload. When you specify the maximum generation, all objects are collected.

The following example forces a garbage collection for generation 2 objects with the Optimized setting.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1, 2.0 SP1

Community Additions

ADD
Show:
© 2014 Microsoft