GC::WaitForFullGCComplete Method ()


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

Returns the status of a registered notification for determining whether a full, blocking garbage collection by the common language runtime has completed.

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

static GCNotificationStatus WaitForFullGCComplete()

Return Value

Type: System::GCNotificationStatus

The status of the registered garbage collection notification.

Use the GCNotificationStatus enumeration returned by this method to determine the status of the current garbage collection notification that was registered by using the RegisterForFullGCNotification method. You can also use the WaitForFullGCApproach method to determine whether a full garbage collection is imminent.

When the enumeration returns Succeeded, you can do tasks such as resuming work and obtaining a collection count with the CollectionCount property.

This method waits indefinitely for a garbage collection notification to be obtained. If you want to specify a time-out period for the method to return if the notification cannot be obtained, use the GC::WaitForFullGCApproach(Int32) method overload. If you call this method without specifying a time-out, you can call the CancelFullGCNotification method if you are waiting longer than preferred.

This method call should be preceded with a call to the WaitForFullGCApproach method to make sure that you have had a full garbage collection. Calling this method alone can produce indeterminate results.

The following example shows how to use this method to determine whether a full garbage collection has completed. Whenever the status of the notification is Succeeded, the user method OnFullGCCompletedNotify is called to perform actions in response to the completed collection. This code example is part of a larger example provided for Garbage Collection Notifications topic.

// Check for a notification of a completed collection.
s = GC::WaitForFullGCComplete();
if (s == GCNotificationStatus::Succeeded)
    Console::WriteLine("GC Notification raised.");
else if (s == GCNotificationStatus::Canceled)
    Console::WriteLine("GC Notification cancelled.");
    // Could be a time out.
    Console::WriteLine("GC Notification not applicable.");


for full trust for the immediate caller. This member cannot be used by partially trusted code.


requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

.NET Framework
Available since 2.0
Return to top