DeleteLogFile 函数 (clfsw32.h)

标记要删除的日志。 当关闭日志的所有句柄、封送区域和读取上下文时,实际上会删除日志。 如果日志是物理日志,则会删除其基础容器。

当日志标记为要删除时,打开新客户端日志流的请求将失败。

注释 一个密切相关的函数 DeleteLogByHandle,当给定文件的句柄时,它将删除日志。

 

语法

CLFSUSER_API BOOL DeleteLogFile(
  [in]           LPCWSTR pszLogFileName,
  [in, optional] PVOID   pvReserved
);

参数

[in] pszLogFileName

日志的名称。

使用 CreateLogFile创建日志时指定此名称。 以下示例标识要使用的格式:

日志:<日志名称>[::<日志流名称>]

< 日志名称> 对应于文件系统中的有效文件路径。

< 日志流名称> 是日志流的唯一名称。

有关详细信息,请参阅 日志类型

[in, optional] pvReserved

此参数保留,应设置为 NULL

返回值

如果函数成功,则返回值为非零。

如果函数失败,则返回值为零(0)。 若要获取扩展的错误信息,请调用 GetLastError。 以下列表标识可能的错误代码:

要求

要求 价值
最低支持的客户端 Windows Vista [仅限桌面应用]
支持的最低服务器 Windows Server 2003 R2 [仅限桌面应用]
目标平台 窗户
标头 clfsw32.h
Clfsw32.lib
DLL Clfsw32.dll

另请参阅

常见日志文件系统函数

CreateLogFile

DeleteLogByHandle

SECURITY_ATTRIBUTES