LogFileEventConsumer クラス

  • [アーティクル]

LogFileEventConsumer クラスは、イベントが届いたときに、カスタマイズされた文字列をテキスト ログ ファイルに書き込みます。 文字列は、改行コードで区切られます。 このクラスは、WMI に用意されている標準イベント コンシューマーの 1 つです。 詳細については、「標準コンシューマーを使用したイベントの監視と対応」を参照してください。

構文

[AMENDMENT]
class LogFileEventConsumer : __EventConsumer
{
  uint8   CreatorSID[];
  string  MachineName;
  uint32  MaximumQueueSize;
  string  Filename;
  boolean IsUnicode;
  uint64  MaximumFileSize = 65535;
  string  Name;
  string  Text;
};

メンバー

LogFileEventConsumer クラスには、次の種類のメンバーがあります。

プロパティ

LogFileEventConsumer クラスには、次のプロパティがあります。

CreatorSID

データ型: uint8 配列

アクセスの種類: 読み取り専用

フィルターを作成するユーザーを一意に識別するセキュリティ識別子 (SID)。 WMI では、オペレーティング システムに応じて、__EventConsumer のインスタンスを作成するユーザーの SID、または管理者の SID が格納されます。 詳細については、「論理コンシューマーを使用してイベント フィルターをバインドする」と「標準コンシューマーを使用したイベントの監視と対応」を参照してください。

このプロパティは、__EventConsumer から継承されます。

Filename

データ型: string

アクセスの種類: 読み取り専用

ログ エントリが追加されるパスを含むファイルの名前。 ファイルが存在しない場合、LogFileEventConsumer によってファイルの作成が試行されます。 パスが存在しない場合、またはコンシューマーを作成するユーザーがファイルまたはパスに対する書き込みアクセス許可を持っていない場合、コンシューマーは失敗します。

IsUnicode

データ型: boolean

アクセスの種類: 読み取り専用

TRUE の場合、ログ ファイルは Unicode テキスト ファイルです。 FALSE の場合、ログ ファイルはマルチバイト コードのテキスト ファイルです。 ファイルが存在する場合、このプロパティは無視され、現在のファイル設定が使用されます。 たとえば、IsUnicode が FALSE であっても、既存のファイルが Unicode ファイルである場合、Unicode が使用されます。 IsUnicode が TRUE でも、ファイルがマルチバイト コードの場合は、マルチバイト コードが使用されます。

MachineName

データ型: string

アクセスの種類: 読み取り専用

Windows Management Instrumentation (WMI) がイベントを送信するコンピューターの名前。

このプロパティは、__EventConsumer から継承されます。

MaximumFileSize

データ型: uint64

アクセスの種類: 読み取り専用

ログ ファイルの最大サイズ (バイト単位)。 プライマリ ファイルが最大サイズを超えた場合、内容は別のファイルに移動され、プライマリ ファイルは空になります。 値 0 はサイズ制限がないことを示します。 既定値は 65,535 バイトです。 ファイルのサイズは、書き込み操作の前にチェックされます。 そのため、指定したサイズ制限をわずかに超えるファイルを作成できます。 次の書き込み操作でそれをキャッチし、新しいファイルを開始します。

次の一覧は、バックアップ ファイルの名前付け構造を示しています。

  • 元のファイル名が 8.3 の場合、拡張子は "001"、"002" などの形式の文字列に置き換えられ、以前に使用および選択されたすべての数値より大きい最小の数値で置き換えられます。 "999" が使用されている場合、選択される数値は未使用の最小数値になります。
  • 元のファイル名が 8.3 でない場合は、"001"、"002" などの形式の文字列がファイル名に追加されます。

スクリプトでの uint64 値の使用の詳細については、WMI でのスクリプト作成に関する記事を参照してください。

MaximumQueueSize

データ型: uint32

アクセスの種類: 読み取り専用

特定のコンシューマーの最大キュー (バイト単位)。

このプロパティは、__EventConsumer から継承されます。

名前

データ型: string

アクセスの種類: 読み取り専用

修飾子: Key

このコンシューマーの一意の名前。

テキスト

データ型: string

アクセスの種類: 読み取り専用

ログ エントリのテキストの標準文字列テンプレート。

解説

注意

LogFileEventConsumer では、ログ ファイルがセキュリティで保護されません。 そのため、LogFileEventConsumer の構成時は、必要なレベルのセキュリティで保護されたディレクトリを指定することが重要です。

LogFileEventConsumer クラスは、__EventConsumer 抽象クラスから派生したものです。

例

LogFileEventConsumer を使用してコンシューマーを作成する例については、「イベントに基づくログ ファイルへの書き込み」を参照してください。

要件

要件 値
サポートされている最小のクライアント
 Windows Vista
サポートされている最小のサーバー
 Windows Server 2008
名前空間
 Root\subscription
MOF
Wbemcons.mof
[DLL]
Wbemcons.dll

関連項目

標準コンシューマー クラス

イベントに基づくログ ファイルへの書き込み

論理コンシューマーの作成

常にイベントを受信する

__EventConsumer