DeleteLogByHandle 函数 (clfsw32.h)
标记要删除的指定日志。 关闭日志的所有句柄、封送区域和读取上下文时,实际上会删除日志。 如果日志是物理日志,则删除其基础容器。
将日志标记为要删除时,打开新客户端日志流的请求会失败。
注意 此函数不同于 DeleteLogFile,因为它需要对日志对象使用有效的打开句柄,而不是日志名称。
语法
CLFSUSER_API BOOL DeleteLogByHandle(
[in] HANDLE hLog
);
参数
[in] hLog
打开的日志的句柄,该句柄是通过成功调用 CreateLogFile 获取的。 日志必须已使用 DELETE 访问权限创建,否则无法删除日志。
返回值
如果该函数成功,则返回值为非零值。
如果函数失败,则返回值为零 (0)。 要获得更多的错误信息,请调用 GetLastError。 以下列表标识了可能的错误代码:
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 R2 [仅限桌面应用] |
目标平台 | Windows |
标头 | clfsw32.h |
Library | Clfsw32.lib |
DLL | Clfsw32.dll |