System.GCNotificationStatus Enumeration

Provides information about the current registration for notification of the next full garbage collection.

Syntax

public enum GCNotificationStatus

Remarks

Use the GC.RegisterForFullGCNotification(int, int) method to register for a full garbage collection notification. Then use the GC.WaitForFullGCApproach method or the GC.WaitForFullGCComplete method to return a GCNotificationStatus enumeration that contains the status of the notification.

Members

Member NameDescription
Canceled

The current registration was canceled by the user.

Failed

The notification failed for any reason.

NotApplicable

This result can be caused by the following: there is no current registration for a garbage collection notification, concurrent garbage collection is enabled, or the time specified for the millisecondsTimeout parameter has expired and no garbage collection notification was obtained. (See the <gcConcurrent> runtime setting for information about how to disable concurrent garbage collection.)

Succeeded

The notification was successful and the registration was not canceled.

Timeout

The time specified by the millisecondsTimeout parameter for either GC.WaitForFullGCApproach(int) or GC.WaitForFullGCComplete(int) has elapsed.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0