Provides information about the current registration for notification of the next full garbage collection.
Assembly: mscorlib (in mscorlib.dll)
The current registration was canceled by the user.
The notification failed for any reason.
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 runtime setting for information about how to disable concurrent garbage collection.)
The notification was successful and the registration was not canceled.
The following example obtains a WaitForFullGCApproach method. If the enumeration returns , 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.enumeration from the
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.") OnFullGCApproachNotify() ElseIf (s = GCNotificationStatus.Canceled) Then Console.WriteLine("GC Notification cancelled.") Exit While Else ' 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.") OnFullGCCompleteEndNotify() ElseIf (s = GCNotificationStatus.Canceled) Then Console.WriteLine("GC Notification cancelled.") Exit While Else ' Could be a time out. Console.WriteLine("GC Notification not applicable.") Exit While End If End While Thread.Sleep(500) ' FinalExit is set to true right before ' the main thread cancelled notification. If finalExit Then Exit While End If End While End Sub
Available since 2.0