LogFileEventConsumer 类

  • 项目

在将事件传递到文本日志文件时，LogFileEventConsumer 类会将自定义字符串写入文本日志文件。 该字符串以行尾序列分隔。 此类是 WMI 提供的标准事件使用者之一。 有关详细信息，请参阅借助标准使用者监视和响应事件。

语法

[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

数据类型：字符串

访问类型：只读

包含日志条目所追加到的路径的文件名称。 如果该文件不存在，LogFileEventConsumer 将尝试创建该文件。 如果路径不存在，或者创建使用者的用户没有文件或路径的写入权限，使用者将失败。

IsUnicode

数据类型：布尔

访问类型：只读

如果为 TRUE，日志文件为 Unicode 文本文件。 如果为 FALSE，日志文件为多字节代码文本文件。 如果文件存在，忽略此属性并使用当前文件设置。 例如，如果 IsUnicode 为 FALSE，但现有文件为 Unicode 文件，则使用 Unicode。 如果 IsUnicode 为 TRUE，但文件为多字节代码，则使用多字节代码。

MachineName

数据类型：字符串

访问类型：只读

Windows Management Instrumentation (WMI) 向其发送事件的计算机名称。

此属性继承自 __EventConsumer。

MaximumFileSize

数据类型：uint64

访问类型：只读

日志文件的最大大小（以字节为单位）。 如果主文件超出其最大大小，内容将移动到其他文件并清空主文件。 零 (0) 值表示没有大小限制。 默认值为 65,535 个字节。 在写入操作之前检查文件大小。 因此，可以有一个略大于指定大小限制的文件。 下一个写入操作将其捕获并启动一个新文件。

以下列表标识备份文件的命名结构：

  • 如果原始文件名为 8.3，扩展名将替换为“001”、“002”等格式的字符串，其最小数字大于先前使用和选择的所有数字。 如果使用的是“999”，所选数字是最小的未使用数字。
  • 如果原始文件名并非 8.3，会将“001”、“002”等格式的字符串追加到文件名中。

有关在脚本中使用 uint64 值的详细信息，请参阅 WMI 中的脚本。

MaximumQueueSize

数据类型：uint32

访问类型：只读

特定使用者的最大队列数（以字节为单位）。

此属性继承自 __EventConsumer。

名称

数据类型：字符串

访问类型：只读

限定符：键

此使用者的唯一名称。

文本

数据类型：字符串

访问类型：只读

日志项目文本的标准字符串模板。

备注

注意

LogFileEventConsumer 不会保护日志文件。 因此，在配置 LogFileEventConsumer 时，务必指定一个受所需级别保护的目录。

LogFileEventConsumer 类派生自 __EventConsumer 抽象类。

示例

有关使用 LogFileEventConsumer 创建使用者的示例，请参阅基于事件写入日志文件。

要求

要求 值
最低受支持的客户端
 Windows Vista
最低受支持的服务器
 Windows Server 2008
命名空间
 Root\subscription
MOF
Wbemcons.mof
DLL
Wbemcons.dll

另请参阅

标准使用者类

基于事件写入日志文件

创建逻辑使用者

随时接收事件

__EventConsumer