IsServerGC Property
Collapse the table of content
Expand the table of content

GCSettings.IsServerGC Property

 

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

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

public static bool IsServerGC { get; }

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.

<configuration>
  <runtime>
    <gcServer enabled="true" />
  </runtime>
</configuration>

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

using System;
using System.Runtime;

class Sample 
{
    public static void Main() 
    {
    string result;

    if (GCSettings.IsServerGC == true)
        result = "server";
    else 
        result = "workstation";
    Console.WriteLine("The {0} garbage collector is running.", result);
    }
}
// The example displays output like the following:
//      The workstation garbage collector is running.

Universal Windows Platform
Available since 4.5
.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
Show:
© 2016 Microsoft