Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

GCNotificationStatus Enumeration

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

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

<SerializableAttribute> _
Public Enumeration GCNotificationStatus

Member nameDescription
CanceledThe current registration was canceled by the user.
FailedThe notification failed for any reason.
NotApplicableThis 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.)
SucceededThe notification was successful and the registration was not canceled.
TimeoutThe time specified by the millisecondsTimeout parameter for either GC.WaitForFullGCApproach(Int32) or GC.WaitForFullGCComplete(Int32) has elapsed.

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

The following example obtains a GCNotificationStatus enumeration from the WaitForFullGCApproach method. If the enumeration returns Succeeded, it calls the custom method OnFullGCApproachNotify to perform actions in response to the approaching full garbage collection. This code example is part of a larger example provided for Garbage Collection Notifications topic.

    Public Shared Sub WaitForFullGCProc()

        While True 
            ' CheckForNotify is set to true and false in Main. 

            While checkForNotify
                ' Check for a notification of an approaching collection. 
                Dim s As GCNotificationStatus = GC.WaitForFullGCApproach
                If (s = GCNotificationStatus.Succeeded) Then
                    Console.WriteLine("GC Notification raised.")
                ElseIf (s = GCNotificationStatus.Canceled) Then
                    Console.WriteLine("GC Notification cancelled.")
                    Exit While 
                    ' This can occur if a timeout period 
                    ' is specified for WaitForFullGCApproach(Timeout)  
                    ' or WaitForFullGCComplete(Timeout)   
                    ' and the time out period has elapsed. 
                    Console.WriteLine("GC Notification not applicable.")
                    Exit While 
                End If 

                ' Check for a notification of a completed collection.
                s = GC.WaitForFullGCComplete
                If (s = GCNotificationStatus.Succeeded) Then
                    Console.WriteLine("GC Notifiction raised.")
                ElseIf (s = GCNotificationStatus.Canceled) Then
                    Console.WriteLine("GC Notification cancelled.")
                    Exit While 
                    ' Could be a time out.
                    Console.WriteLine("GC Notification not applicable.")
                    Exit While 
                End If 

            End While
            ' FinalExit is set to true right before   
            ' the main thread cancelled notification. 
            If finalExit Then 
                Exit While 
            End If 

        End While 
    End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1, 3.0 SP2, 2.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
© 2015 Microsoft