GCSettings::LatencyMode Property

.NET Framework (current version)

Gets or sets the current latency mode for garbage collection.

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

Syntax

public:
property GCLatencyMode LatencyMode {
	static GCLatencyMode get();
	[SecurityCriticalAttribute]
	[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
	static void set(GCLatencyMode value);
}

Property Value

Type: System.Runtime::GCLatencyMode

One of the enumeration values that specifies the latency mode.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The LatencyMode property is being set to an invalid value. -or- The LatencyMode property cannot be set to GCLatencyMode::NoGCRegion.

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.

Security

SecurityCriticalAttribute

requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1