EventLog.MaximumKilobytes プロパティ

.NET Framework クラス ライブラリ リファレンス

EventLog.MaximumKilobytes プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

イベント ログの最大サイズをキロバイト単位で取得または設定します。

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(False)> _
Public Property MaximumKilobytes As
 Long

Visual Basic (使用法)

Dim instance As EventLog
Dim value As Long

value = instance.MaximumKilobytes

instance.MaximumKilobytes = value

C#

[ComVisibleAttribute(false)] 
public long MaximumKilobytes { get; set;
 }

C++

[ComVisibleAttribute(false)] 
public:
property long long MaximumKilobytes {
    long long get ();
    void set (long long value);
}

J#

/** @property */
public long get_MaximumKilobytes ()

/** @property */
public void set_MaximumKilobytes (long value)

JScript

public function get MaximumKilobytes
 () : long

public function set MaximumKilobytes
 (value : long)

プロパティ値
イベント ログの最大サイズ。単位はキロバイトです。既定値は、512 KB の最大ファイル サイズを示す 512 です。

例外

例外の種類	条件
ArgumentOutOfRangeException	指定した値が 64 未満か、4194240 を超える値です。または、64 の倍数ではありません。
InvalidOperationException	Log 値が有効なログ名ではありません。 または 対象のコンピュータ上のイベント ログのレジストリ キーを開けませんでした。

解説

MaximumKilobytes プロパティは、イベント ログ ファイルのサイズ制限を表します。イベント ログがサイズ制限に達すると、構成した OverflowAction 値によって、新しいエントリを破棄するかどうか、または新しいエントリで古いエントリを上書きするかどうかが決定されます。

メモ
このプロパティは、このインスタンスで表されるイベント ログの構成設定を表します。イベント ログが最大サイズに達すると、このプロパティによって、オペレーティング システムがイベント ログに登録されたすべてのイベント ソースによって書き込まれる新しいエントリを処理する方法が指定されます。

使用例

ローカル コンピュータで定義されたイベント ログを列挙し、各イベント ログの構成情報を表示する例を次に示します。

Visual Basic

Shared Sub DisplayEventLogProperties()

   ' Iterate through the current set of event log files,
   ' displaying the property settings for each file.
   Dim eventLogs As EventLog() = EventLog.GetEventLogs()
   
   Dim e As EventLog
   For Each e In  eventLogs
      Dim sizeKB As Int64 = 0
      
      Console.WriteLine()
      Console.WriteLine("{0}:", e.LogDisplayName)
      Console.WriteLine("  Log name = " + ControlChars.Tab
 _
                          + ControlChars.Tab + " {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.
      Dim regEventLog As RegistryKey
      regEventLog = Registry.LocalMachine.OpenSubKey( _
             ("System\CurrentControlSet\Services\EventLog\"
 + e.Log))

      If Not (regEventLog Is
 Nothing) Then

         Dim temp As Object
 = regEventLog.GetValue("File")
         If Not (temp Is
 Nothing) Then

            Console.WriteLine("  Log file path = "
 + ControlChars.Tab _
                                  + " {0}", temp.ToString())
            Dim file As New
 FileInfo(temp.ToString())
            
            ' Get the current size of the event log file.
            If file.Exists Then
               sizeKB = file.Length / 1024
               If file.Length Mod 1024 <>
 0 Then
                  sizeKB += 1
               End If
               Console.WriteLine("  Current size = "
 + ControlChars.Tab _
                          + " {0} kilobytes", sizeKB.ToString())
            End If
         Else
            Console.WriteLine("  Log file path = "
 + ControlChars.Tab _
                             + " <not set>")
         End If
      End If
      
      ' Display the maximum size and overflow settings.
      sizeKB = e.MaximumKilobytes
      Console.WriteLine("  Maximum size = " + ControlChars.Tab
 _
                         + " {0} kilobytes", sizeKB.ToString())
      Console.WriteLine("  Overflow setting = " +
 ControlChars.Tab _
                         + " {0}", e.OverflowAction.ToString())
      
      Select Case e.OverflowAction
         Case OverflowAction.OverwriteOlder
            Console.WriteLine(ControlChars.Tab + _
                 " Entries are retained a minimum of {0} days.",
 _
                 e.MinimumRetentionDays)
         Case OverflowAction.DoNotOverwrite
            Console.WriteLine(ControlChars.Tab + _
                 " Older entries are not overwritten.")
         Case OverflowAction.OverwriteAsNeeded
            Console.WriteLine(ControlChars.Tab + _
                 " If number of entries equals max size limit,
 a new event log entry overwrites the oldest entry.")
         Case Else
      End Select

   Next e

End Sub

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;
        }
    }
}

J#

static void DisplayEventLogProperties()
{
    // Iterate through the current set of event log files,
    // displaying the property settings for each file.
    EventLog eventLogs[] = EventLog.GetEventLogs();
    EventLog e;
    for ( int iCtr = 0; iCtr < eventLogs.length;
 iCtr++ ) {
        e = eventLogs[iCtr];
        long sizeKB = 0;

        Console.WriteLine();
        Console.WriteLine("{0}:", e.get_LogDisplayName());
        Console.WriteLine("  Log name = \t\t {0}", e.get_Log());
        Console.WriteLine("  Number of event log entries = {0}",
            ((Int32)e.get_Entries().get_Count()).ToString());

        // Determine if there is an event log file for this event log.
        RegistryKey regEventLog = Registry.LocalMachine.
            OpenSubKey("System\\CurrentControlSet\\Services\\EventLog\\"
            + e.get_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.get_Exists()) {
                    sizeKB = file.get_Length() / 1024;
                    if (file.get_Length() % 1024 != 0) {
                        sizeKB++;
                    }

                    Console.WriteLine("  Current size = \t {0} kilobytes"
,
                        ((Int64)sizeKB).ToString());
                }
            }
            else {
                Console.WriteLine("  Log file path = \t <not set>");
            }
        }

        // Display the maximum size and overflow settings.
        sizeKB = e.get_MaximumKilobytes();
        Console.WriteLine("  Maximum size = \t {0} kilobytes", 
            ((Int64)sizeKB).ToString());
        Console.WriteLine("  Overflow setting = \t {0}",
            e.get_OverflowAction().ToString());
        switch (e.get_OverflowAction()) {
            case OverflowAction.OverwriteOlder :
                Console.WriteLine("\t Entries are retained a minimum of "
                    + "{0} days.", (Int32)e.get_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;
        }
    }
} //DisplayEventLogProperties

.NET Framework のセキュリティ

• EventLogPermission  (コンピュータのイベント ログ情報の管理) EventLogPermissionAccess.Administer (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
EventLog クラス
EventLog メンバ
System.Diagnostics 名前空間
OverflowAction
ModifyOverflowPolicy