GCSettings.LatencyMode Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the current latency mode for garbage collection.
public:
static property System::Runtime::GCLatencyMode LatencyMode { System::Runtime::GCLatencyMode get(); void set(System::Runtime::GCLatencyMode value); };public static System.Runtime.GCLatencyMode LatencyMode { get; [System.Security.SecurityCritical] set; }public static System.Runtime.GCLatencyMode LatencyMode { get; set; }[<set: System.Security.SecurityCritical>]
static member LatencyMode : System.Runtime.GCLatencyMode with get, setstatic member LatencyMode : System.Runtime.GCLatencyMode with get, setPublic Shared Property LatencyMode As GCLatencyModeProperty Value
One of the enumeration values that specifies the latency mode.
- Attributes
Exceptions
The LatencyMode property is being set to an invalid value.
-or-
The LatencyMode property cannot be set to NoGCRegion.
Remarks
You can reduce the level of intrusiveness of garbage collection in your application by setting the GCLatencyMode to LowLatency during critical operations. After such operations are completed, return to a higher latency mode so that more objects can be reclaimed to increase memory.
Ordinarily, you set the value of the LatencyMode property to define the garbage collector's latency mode. However, you cannot set the no GC region latency mode by assigning the GCLatencyMode.NoGCRegion enumeration value to the LatencyMode property. Instead, you call the GC.TryStartNoGCRegion method to begin the no GC region latency mode, and you call the GC.EndNoGCRegion to end it.
See Latency Modes for a discussion of how the runtime configuration settings for garbage collection affect the default value of the GCLatencyMode enumeration.
