GC.EndNoGCRegion Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

GC.CoreCLR.cs

Ends the no GC region latency mode.

public:
 static void EndNoGCRegion();

public static void EndNoGCRegion ();

static member EndNoGCRegion : unit -> unit

Public Shared Sub EndNoGCRegion ()

Exceptions

InvalidOperationException

The garbage collector is not in no GC region latency mode.

-or-

The no GC region latency mode was ended previously because a garbage collection was induced.

-or-

A memory allocation exceeded the amount specified in the call to the TryStartNoGCRegion(Int64) method.

Remarks

The EndNoGCRegion method throws an InvalidOperationException if the garbage collector is not in no GC region latency mode. This occurs under any of the following conditions:

• The TryStartNoGCRegion method was not called previously.

• The call to the TryStartNoGCRegion method returned false.

• The call to the TryStartNoGCRegion method threw an exception.

You can prevent an exception for any of these reasons by using code such as the following:

if (GCSettings.LatencyMode == GCLatencyMode.NoGCRegion)
   GC.EndNoGCRegion();

if GCSettings.LatencyMode = GCLatencyMode.NoGCRegion then
    GC.EndNoGCRegion()

If GCSettings.LatencyMode = GCLatencyMode.NoGCRegion Then
   GC.EndNoGCRegion()
End If

See also

• TryStartNoGCRegion(Int64)
• LatencyMode
• Latency Modes