GC.Collect Method (Int32, GCCollectionMode)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Forces a garbage collection from generation 0 through a specified generation, at a time specified by a GCCollectionMode value.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Shared Sub Collect ( _ generation As Integer, _ mode As 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 enumeration values that specifies the behavior for the garbage collection.
| Exception | Condition |
|---|---|
| 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.