GCNotificationStatus Enumeration

Definition

Bietet Informationen über die aktuelle Registrierung für eine Benachrichtigung über die nächste vollständige Garbage Collection.Provides information about the current registration for notification of the next full garbage collection.

public enum class GCNotificationStatus
[System.Serializable]
public enum GCNotificationStatus
type GCNotificationStatus = 
Public Enum GCNotificationStatus
Vererbung
GCNotificationStatus
Attribute

Felder

Canceled 2

Die aktuelle Registrierung wurde vom Benutzer abgebrochen.The current registration was canceled by the user.

Failed 1

Fehler bei der Benachrichtigung aus beliebigem Grund.The notification failed for any reason.

NotApplicable 4

Für dieses Ergebnis kommt folgende Ursache infrage: Es ist keine aktuelle Registrierung für eine Garbage Collection-Benachrichtigung vorhanden, die gleichzeitige Garbage Collection ist aktiviert, oder die für den millisecondsTimeout-Parameter angegebene Zeit ist abgelaufen, und keine Garbage Collection-Benachrichtigung wurde abgerufen.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. (Weitere Informationen zum Deaktivieren der gleichzeitigen Garbage Collection finden Sie unter der <gcConcurrent>-Laufzeiteinstellung.)(See the <gcConcurrent> runtime setting for information about how to disable concurrent garbage collection.)

Succeeded 0

Die Benachrichtigung war erfolgreich, und die Registrierung wurde nicht abgebrochen.The notification was successful and the registration was not canceled.

Timeout 3

Die vom millisecondsTimeout-Parameter entweder für WaitForFullGCApproach(Int32) oder WaitForFullGCComplete(Int32) angegebene Zeit ist verstrichen.The time specified by the millisecondsTimeout parameter for either WaitForFullGCApproach(Int32) or WaitForFullGCComplete(Int32) has elapsed.

Beispiele

Im folgenden Beispiel wird eine GCNotificationStatus -Enumeration aus WaitForFullGCApproach der-Methode abgerufen.The following example obtains a GCNotificationStatus enumeration from the WaitForFullGCApproach method. Wenn die Enumeration erfolgreich zurückgegeben wird, wird die Benutzer OnFullGCApproachNotify definierte-Methode aufgerufen, um Aktionen als Reaktion auf den bevorstehenden vollständigen Garbage Collection auszuführen.If the enumeration returns Succeeded, it calls the custom method OnFullGCApproachNotify to perform actions in response to the approaching full garbage collection. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für das Thema zur Garbage Collection-Benachrichtigungen bereitgestellt wird.This code example is part of a larger example provided for Garbage Collection Notifications topic.

public:
    static void WaitForFullGCProc()
    {
        while (true)
        {
            // CheckForNotify is set to true and false in Main.
            while (checkForNotify)
            {
                // Check for a notification of an approaching collection.
                GCNotificationStatus s = GC::WaitForFullGCApproach();
                if (s == GCNotificationStatus::Succeeded)
                {
                    Console::WriteLine("GC Notifiction raised.");
                    OnFullGCApproachNotify();
                }
                else if (s == GCNotificationStatus::Canceled)
                {
                    Console::WriteLine("GC Notification cancelled.");
                    break;
                }
                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.");
                    break;
                }

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


            Thread::Sleep(500);
            // FinalExit is set to true right before
            // the main thread cancelled notification.
            if (finalExit)
            {
                break;
            }
        }
    }
public static void WaitForFullGCProc()
{
    while (true)
    {
        // CheckForNotify is set to true and false in Main.
        while (checkForNotify)
        {
            // Check for a notification of an approaching collection.
            GCNotificationStatus s = GC.WaitForFullGCApproach();
            if (s == GCNotificationStatus.Succeeded)
            {
                Console.WriteLine("GC Notification raised.");
                OnFullGCApproachNotify();
            }
            else if (s == GCNotificationStatus.Canceled)
            {
                Console.WriteLine("GC Notification cancelled.");
                break;
            }
            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.");
                break;
            }

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


        Thread.Sleep(500);
        // FinalExit is set to true right before  
        // the main thread cancelled notification.
        if (finalExit)
        {
            break;
        }
    }

}
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

Hinweise

Verwenden Sie RegisterForFullGCNotification die-Methode, um eine vollständige Garbage Collection Benachrichtigung zu registrieren.Use the RegisterForFullGCNotification method to register for a full garbage collection notification. Verwenden Sie dann WaitForFullGCApproach die-Methode WaitForFullGCComplete oder die-Methode GCNotificationStatus , um eine-Enumeration zurückzugeben, die den Status der Benachrichtigung enthält.Then use the WaitForFullGCApproach method or the WaitForFullGCComplete method to return a GCNotificationStatus enumeration that contains the status of the notification.

Gilt für:

Siehe auch