clfsDeleteLogFile 函数 (wdm.h)

ClfsDeleteLogFile 例程标记要删除的 CLFS 流。

语法

CLFSUSER_API NTSTATUS ClfsDeleteLogFile(
  [in]           PUNICODE_STRING puszLogFileName,
                 PVOID           pvReserved,
  [in]           ULONG           fLogOptionFlag,
  [in, optional] PVOID           pvContext,
  [in]           ULONG           cbContext
);

参数

[in] puszLogFileName

指向 UNICODE_STRING 结构的指针,该结构提供要删除的 CLFS 流的名称。

如果要删除的流是专用日志的唯一流,则名称的格式为 log:physical log name,其中 物理日志名称 是基础文件系统上物理日志的路径名称。

如果要删除的流是多路复用日志的流之一,则名称的格式为 log:physical log name::stream name,其中 物理日志名称 是基础文件系统上物理日志的路径 名称,流名称 是要删除的流的唯一名称。

pvReserved

保留。

[in] fLogOptionFlag

一个 值,该值指示 CLFS 与删除日志的组件之间的关系。 有关可能值的列表,请参阅 ClfsCreateLogFile 例程的 fLogOptionFlag 参数的说明。

[in, optional] pvContext

指向上下文的指针。 解释上下文的方式取决于 在 fLogOptionFlag 中传递的值。

[in] cbContext

pvContext 指向的上下文的大小(以字节为单位)。 如果 pvContext 不为 NULL,则此参数必须大于零。

返回值

ClfsDeleteLogFile 如果成功,则返回STATUS_SUCCESS;否则,它将返回 Ntstatus.h 中定义的错误代码之一。

注解

通用日志文件系统 (CLFS) 使用 LOG_FILE_OBJECT 结构来表示日志。 ClfsCreateLogFile 函数返回指向 LOG_FILE_OBJECT 的指针,客户端随后将该指针传递给其他 CLFS 函数。

CLFS 客户端不直接访问LOG_FILE_OBJECT结构的成员。 有关成员的信息,请参阅 FILE_OBJECT

ClfsDeleteLogFile 标记要删除的流,但不关闭当前打开的任何日志文件对象。 若要关闭日志文件对象,请调用 ClfsCloseLogFileObject。 关闭与流关联的所有日志文件对象后,将删除标记为要删除的流。

标记为要删除的 CLFS 流将拒绝后续打开该流的请求。

物理 CLFS 日志的名称不包括 .blf 扩展名。

有关 CLFS 概念和术语的说明,请参阅 通用日志文件系统

要求

要求
最低受支持的客户端 在 Windows Server 2003 R2、Windows Vista 和更高版本的 Windows 中可用。
目标平台 桌面
标头 wdm.h (包括 Wdm.h)
Library Clfs.lib
DLL Clfs.sys
IRQL <= APC_LEVEL

另请参阅

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsCreateLogFile

ClfsDeleteLogByPointer