EventLog.ModifyOverflowPolicy(OverflowAction, Int32) Méthode

Définition

Espace de noms:

System.Diagnostics

Assembly:

System.Diagnostics.EventLog.dll

Paquet:

System.Diagnostics.EventLog v8.0.0

Source:

EventLog.cs

Modifie le comportement configuré pour l'écriture de nouvelles entrées quand le journal des événements atteint sa taille de fichier maximale.

public:
 void ModifyOverflowPolicy(System::Diagnostics::OverflowAction action, int retentionDays);

public void ModifyOverflowPolicy (System.Diagnostics.OverflowAction action, int retentionDays);

member this.ModifyOverflowPolicy : System.Diagnostics.OverflowAction * int -> unit

Public Sub ModifyOverflowPolicy (action As OverflowAction, retentionDays As Integer)

Paramètres

action

OverflowAction

Comportement de dépassement de capacité pour l'écriture de nouvelles entrées dans le journal des événements.

retentionDays

Int32

Durée minimale exprimée en jours de conservation de chaque entrée du journal des événements. Ce paramètre n'est utilisé que si action a la valeur OverwriteOlder.

Exceptions

InvalidEnumArgumentException

action n’est pas une valeur de OverflowAction valide.

ArgumentOutOfRangeException

retentionDays est inférieur à un ou supérieur à 365.

InvalidOperationException

Log n'est pas un nom de journal valide.

- ou -

La clé de Registre du journal des événements n'a pas pu être ouverte sur l'ordinateur cible.

Exemples

L’exemple suivant affiche la stratégie de dépassement de capacité configurée pour un journal des événements spécifié et permet à l’utilisateur de sélectionner un nouveau paramètre de stratégie de dépassement de capacité pour le journal des événements.

// Display the current event log overflow settings, and 
// prompt the user to input a new overflow setting.
void ChangeEventLogOverflowAction( String^ logName )
{
   if ( EventLog::Exists( logName ) )
   {
      
      // Display the current overflow setting of the 
      // specified event log.
      EventLog^ inputLog = gcnew EventLog( logName );
      Console::WriteLine( "  Event log {0}", inputLog->Log );
      OverflowAction logOverflow = inputLog->OverflowAction;
      Int32 numDays = inputLog->MinimumRetentionDays;
      Console::WriteLine( "  Current overflow setting = {0}", logOverflow );
      if ( logOverflow == OverflowAction::OverwriteOlder )
      {
         Console::WriteLine( "\t Entries are retained a minimum of {0} days.", numDays );
      }
      
      // Prompt user for a new overflow setting.
      GetNewOverflowSetting(  &logOverflow,  &numDays );
      
      // Change the overflow setting on the event log.
      if ( logOverflow != inputLog->OverflowAction )
      {
         inputLog->ModifyOverflowPolicy( logOverflow, numDays );
         Console::WriteLine( "Event log overflow policy was modified successfully!" );
      }
      else
      {
         Console::WriteLine( "Event log overflow policy was not modified." );
      }
   }
   else
   {
      Console::WriteLine( "Event log {0} was not found.", logName );
   }
}

// Display the current event log overflow settings, and
// prompt the user to input a new overflow setting.
public static void ChangeEventLogOverflowAction(String logName)
{
    if (EventLog.Exists(logName))
    {
        // Display the current overflow setting of the
        // specified event log.
        EventLog inputLog = new EventLog(logName);
        Console.WriteLine("  Event log {0}", inputLog.Log);

        OverflowAction logOverflow = inputLog.OverflowAction;
        Int32 numDays = inputLog.MinimumRetentionDays;

        Console.WriteLine("  Current overflow setting = {0}",
            logOverflow.ToString());
        if (logOverflow == OverflowAction.OverwriteOlder)
        {
            Console.WriteLine("\t Entries are retained a minimum of {0} days.",
                numDays.ToString());
        }

        // Prompt user for a new overflow setting.
        GetNewOverflowSetting(ref logOverflow, ref numDays);

        // Change the overflow setting on the event log.
        if (logOverflow != inputLog.OverflowAction)
        {
            inputLog.ModifyOverflowPolicy(logOverflow, numDays);
            Console.WriteLine("Event log overflow policy was modified successfully!");
        }
        else
        {
            Console.WriteLine("Event log overflow policy was not modified.");
        }
    }
    else
    {
        Console.WriteLine("Event log {0} was not found.", logName);
    }
}

 ' Display the current event log overflow settings, and 
 ' prompt the user to input a new overflow setting.
 Shared Sub ChangeEventLogOverflowAction(logName As String)

     If EventLog.Exists(logName) Then 
         Dim inputLog As EventLog = New EventLog(logName)
         Console.WriteLine("  Event log {0}", inputLog.Log)

         Dim logOverflow As OverflowAction = inputLog.OverflowAction
         Dim numDays As Int32 = inputLog.MinimumRetentionDays

         Console.WriteLine("  Current overflow setting = {0}", _
                           logOverflow.ToString())

         ' Prompt user for a new overflow setting.
         GetNewOverflowSetting(logOverflow, numDays)

         If Not logOverflow = inputLog.OverflowAction Then
             inputLog.ModifyOverflowPolicy(logOverflow, numDays)
             Console.WriteLine("Event log overflow policy was modified successfully!")
         Else
             Console.WriteLine("Event log overflow policy was not modified.")
         End If
         
     Else
         Console.WriteLine("Event log {0} was not found.", logName)
     End If

 End Sub

Remarques

Le comportement de dépassement de capacité d’un journal des événements spécifie ce qui se passe lorsque de nouvelles entrées doivent être écrites dans un journal qui a atteint sa taille de fichier maximale.

Notes

Le comportement de dépassement de capacité prend effet uniquement lorsqu’un journal des événements atteint sa taille de fichier maximale. Le comportement de dépassement n’affecte pas l’écriture d’une nouvelle entrée dans un journal qui peut prendre en charge des entrées de journal des événements supplémentaires.

La ModifyOverflowPolicy méthode configure le comportement de dépassement de capacité d’un journal des événements. EventLoginstance. Après avoir appelé cette méthode pour le journal des événements spécifié par la propriété , les Log valeurs de propriété OverflowAction et MinimumRetentionDays reflètent le comportement de dépassement de capacité nouvellement configuré.

Notes

Cette propriété représente un paramètre de configuration pour le journal des événements représenté par cette instance. Lorsque le journal des événements atteint sa taille maximale, cette propriété spécifie comment le système d’exploitation gère les nouvelles entrées écrites par toutes les sources d’événements inscrites pour le journal des événements.

Définissez le action paramètre sur OverwriteAsNeeded pour indiquer qu’une nouvelle entrée remplace l’entrée la plus ancienne lorsque le EventLog atteint sa taille maximale. Si le action paramètre est défini sur OverwriteAsNeeded, la valeur du retentionDays paramètre est ignorée.

Définissez le action paramètre sur OverwriteOlder pour indiquer que chaque nouvelle entrée remplace les entrées plus anciennes lorsque le EventLog atteint sa taille maximale. Spécifiez le nombre de jours pendant lesquels les événements doivent être conservés dans le journal à l’aide du retentionDays paramètre . Les événements écrits dans la plage de rétention ne sont pas remplacés par de nouvelles entrées.

Définissez le paramètre sur actionDoNotOverwrite pour ignorer les nouveaux événements lorsque la taille maximale du journal est atteinte. Si le action paramètre est défini sur DoNotOverwrite, la valeur du retentionDays paramètre est ignorée.

Attention

La définition de la stratégie de DoNotOverwrite dépassement de capacité sur spécifie que les nouvelles entrées sont ignorées lorsque le journal des événements est plein. Si vous utilisez ce paramètre, vérifiez que le journal des événements est régulièrement archivé et effacé pour éviter d’atteindre sa limite de taille maximale.

Voir aussi

• OverflowAction
• MaximumKilobytes
• OverflowAction
• MinimumRetentionDays