GCSettings.LatencyMode Property (System.Runtime)

.NET Framework Class Library

GCSettings..::.LatencyMode Property

Updated: October 2009

Gets or sets the current latency mode for garbage collection.

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

Syntax

Visual Basic (Declaration)

Public Shared Property LatencyMode As GCLatencyMode

Visual Basic (Usage)

Dim value As GCLatencyMode

value = GCSettings.LatencyMode

GCSettings.LatencyMode = value

public static GCLatencyMode LatencyMode { get; set; }

Visual C++

public:
static property GCLatencyMode LatencyMode {
    GCLatencyMode get ();
    void set (GCLatencyMode value);
}

JScript

public static function get LatencyMode () : GCLatencyMode
public static function set LatencyMode (value : GCLatencyMode)

Property Value

Type: System.Runtime..::.GCLatencyMode
One of the GCLatencyMode values.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	GCLatencyMode is set to an invalid value.

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.

See Latency Modes for a discussion of how the runtime configuration settings for garbage collection affect the default value of the GCLatencyMode enumeration.

.NET Framework Security

SecurityAction..::.LinkDemand
for full trust for the immediate caller. This member cannot be used by partially trusted code.

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5 SP1, 3.0 SP1, 2.0 SP1

Reference

GCSettings Class

GCSettings Members

System.Runtime Namespace

Other Resources

Latency Modes

Change History

Date	History	Reason
October 2009	Added exception.	Information enhancement.

Date

History

Reason

October 2009

Added exception.

Information enhancement.