EventLog.ModifyOverflowPolicy(OverflowAction, Int32) Метод

Определение

Пространство имен:

System.Diagnostics

Сборка:

System.Diagnostics.EventLog.dll

Исходный код:

EventLog.cs

Изменяет настроенное поведение для записи новых записей, когда журнал событий достигает максимального размера файла.

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)

Параметры

action

OverflowAction

Поведение переполнения для записи новых записей в журнал событий. Значение не должно быть равно OverwriteOlder.

retentionDays

Int32

Устарело. Должно быть равно 0.

Исключения

InvalidEnumArgumentException

action недопустимое OverflowAction значение.

ArgumentOutOfRangeException

retentionDays меньше одного или больше 365.

InvalidOperationException

Значение Log не является допустимым именем журнала.

–или–

Не удалось открыть раздел реестра для журнала событий на целевом компьютере.

Примеры

В следующем примере отображается настроенная политика переполнения для указанного журнала событий и позволяет пользователю выбрать новый параметр политики переполнения для журнала событий.

// 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

Комментарии

Поведение переполнения для журнала событий указывает, что происходит при записи новых записей в журнал, который достиг максимального размера файла.

Замечание

Поведение переполнения действует только в том случае, если журнал событий достигает максимального размера файла. Поведение переполнения не влияет на запись новой записи в журнал, которая может содержать дополнительные записи журнала событий.

Метод ModifyOverflowPolicy настраивает поведение переполнения журнала событий. EventLog Экземпляр. После вызова этого метода для журнала событий, указанного Log свойством, OverflowAction значения свойств MinimumRetentionDays отражают только что настроенное поведение переполнения.

Замечание

Это свойство представляет параметр конфигурации для журнала событий, представленного этим экземпляром. Когда журнал событий достигает максимального размера, это свойство указывает, как операционная система обрабатывает новые записи, записанные всеми источниками событий, зарегистрированными для журнала событий.

action Задайте параметру, чтобы OverwriteAsNeeded указать, что новая запись перезаписывает старую запись, когда EventLog достигает максимального размера. action Если для параметра задано OverwriteAsNeededзначение, retentionDays значение параметра игнорируется.

action Задайте параметру, чтобы DoNotOverwrite отменить новые события при достижении максимального размера журнала. action Если для параметра задано DoNotOverwriteзначение, retentionDays значение параметра игнорируется.

Предупреждение

Никогда не устанавливайте action для параметра OverwriteOlderзначение . Это значение устарело и может привести к тому, что журнал будет вести себя так, как если DoNotOverwrite бы параметр был передан.

Предостережение

Установка политики переполнения, указывающая DoNotOverwrite , что новые записи удаляются при заполнении журнала событий. Если этот параметр используется, убедитесь, что журнал событий регулярно архивируется и очищается, чтобы избежать достижения максимального предела размера.

См. также раздел

• OverflowAction
• MaximumKilobytes
• OverflowAction
• MinimumRetentionDays