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 [仅限桌面应用] |
目标平台 | Windows |
标头 | clfsw32.h |
Library | Clfsw32.lib |
DLL | Clfsw32.dll |