GCSettings.IsServerGC Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value that indicates whether server garbage collection is enabled.

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

Public Shared ReadOnly Property IsServerGC As Boolean

Property Value

Type: System.Boolean

true if server garbage collection is enabled; otherwise, false.

For information about server garbage collection, see the "Workstation and Server Garbage Collection" section in Fundamentals of Garbage Collection.

If server garbage collection is not enabled, workstation garbage collection is in effect (with or without concurrent collection). Server garbage collection is available only on multiprocessor computers.

An unmanaged host can request server garbage collection, and the host request overrides configuration file settings. If the host does not specify the type of garbage collection, you can use a configuration file setting to specify server garbage collection. This setting is valid only in the application configuration file, not in the machine configuration file (see Configuring Apps by using Configuration Files). The following example shows the contents of a sample application configuration file that enables server garbage collection.

    <gcServer enabled="true" />

The following example indicates whether the host computer is using server or workstation garbage collection.

Imports System
Imports System.Runtime

Class Sample
   Public Shared Sub Main()
      Dim result As String

      If GCSettings.IsServerGC = True Then
         result = "server"
         result = "workstation"
      End If
      Console.WriteLine("The {0} garbage collector is running.", result)
   End Sub
End Class 
' The example displays output like the following:
'      The workstation garbage collector is running.

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
Return to top