EventLog.OverflowAction 屬性

定義

當事件記錄檔到達最大記錄檔大小時,取得儲存新項目的已設定行為。

C#
[System.ComponentModel.Browsable(false)]
public System.Diagnostics.OverflowAction OverflowAction { get; }
C#
[System.ComponentModel.Browsable(false)]
[System.Runtime.InteropServices.ComVisible(false)]
public System.Diagnostics.OverflowAction OverflowAction { get; }

屬性值

OverflowAction 值,指定當事件記錄檔到達最大記錄檔大小時,儲存新項目的已設定行為。 預設為 OverwriteOlder

屬性

範例

下列範例會列舉本機計算機上定義的事件記錄檔,並顯示每個事件記錄檔的組態詳細數據。

C#
static void DisplayEventLogProperties()
{
    // Iterate through the current set of event log files,
    // displaying the property settings for each file.

    EventLog[] eventLogs = EventLog.GetEventLogs();
    foreach (EventLog e in eventLogs)
    {
        Int64 sizeKB = 0;

        Console.WriteLine();
        Console.WriteLine("{0}:", e.LogDisplayName);
        Console.WriteLine("  Log name = \t\t {0}", e.Log);

        Console.WriteLine("  Number of event log entries = {0}", e.Entries.Count.ToString());

        // Determine if there is an event log file for this event log.
        RegistryKey regEventLog = Registry.LocalMachine.OpenSubKey("System\\CurrentControlSet\\Services\\EventLog\\" + e.Log);
        if (regEventLog != null)
        {
            Object temp = regEventLog.GetValue("File");
            if (temp != null)
            {
                Console.WriteLine("  Log file path = \t {0}", temp.ToString());
                FileInfo file = new FileInfo(temp.ToString());

                // Get the current size of the event log file.
                if (file.Exists)
                {
                    sizeKB = file.Length / 1024;
                    if ((file.Length % 1024) != 0)
                    {
                        sizeKB++;
                    }
                    Console.WriteLine("  Current size = \t {0} kilobytes", sizeKB.ToString());
                }
            }
            else
            {
                Console.WriteLine("  Log file path = \t <not set>");
            }
        }

        // Display the maximum size and overflow settings.

        sizeKB = e.MaximumKilobytes;
        Console.WriteLine("  Maximum size = \t {0} kilobytes", sizeKB.ToString());
        Console.WriteLine("  Overflow setting = \t {0}", e.OverflowAction.ToString());

        switch (e.OverflowAction)
        {
            case OverflowAction.OverwriteOlder:
                Console.WriteLine("\t Entries are retained a minimum of {0} days.",
                    e.MinimumRetentionDays);
                break;
            case OverflowAction.DoNotOverwrite:
                Console.WriteLine("\t Older entries are not overwritten.");
                break;
            case OverflowAction.OverwriteAsNeeded:
                Console.WriteLine("\t If number of entries equals max size limit, a new event log entry overwrites the oldest entry.");
                break;
            default:
                break;
        }
    }
}

備註

事件記錄檔的大小會隨著新事件寫入而成長。 每個事件記錄檔都有設定的大小上限; MaximumKilobytes 屬性會定義事件記錄檔大小允許的最大 KB 數目。

OverflowAction使用屬性值來檢查事件記錄檔的大小上限所設定的溢位行為。 ModifyOverflowPolicy使用方法來變更事件記錄檔的溢位行為。

備註

只有在事件記錄檔達到檔案大小上限時,溢位行為才會生效。 溢位行為不會影響將新專案寫入可容納其他事件記錄檔項目的記錄檔。

適用於

產品 版本
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

另請參閱