evtClearLog 函数 (winevt.h)

  • 项目

从指定通道中删除所有事件，并将其写入目标日志文件。

语法

BOOL EvtClearLog(
  [in, optional] EVT_HANDLE Session,
  [in]           LPCWSTR    ChannelPath,
  [in, optional] LPCWSTR    TargetFilePath,
  [in]           DWORD      Flags
);

参数

[in, optional] Session

EvtOpenSession 函数返回的远程会话句柄。 对于本地通道，设置为 NULL 。

[in] ChannelPath

要清除的通道的名称。

[in, optional] TargetFilePath

将接收事件的目标日志文件的完整路径。 设置为 NULL 可清除日志文件，且不保存事件。

[in] Flags

保留。 必须为零。

返回值

返回代码/值 说明
TRUE
 函数成功。
FALSE
 函数失败。 使用 GetLastError 函数获取错误代码。

注解

若要从通道或日志文件复制事件，请调用 EvtExportLog 函数。

必须指定目标日志文件的绝对路径;不能使用相对路径和环境变量来指定目标日志文件。 路径可以是 UNC) 路径 (通用命名约定。 应使用 .evtx 作为文件扩展名。

此函数仅影响通道 ，如果通道使用 autoBackup 或 fileMax，则此函数不会影响这些备份文件。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 winevt.h
Library Wevtapi.lib
DLL Wevtapi.dll

另请参阅

EvtArchiveExportedLog

EvtExportLog