clfsGetContainerName 函数 (wdm.h)

  • 项目

ClfsGetContainerName 例程返回指定容器的路径名称。

语法

CLFSUSER_API NTSTATUS ClfsGetContainerName(
  [in]            PLOG_FILE_OBJECT  plfoLog,
  [in]            CLFS_CONTAINER_ID cidLogicalContainer,
  [out]           PUNICODE_STRING   puszContainerName,
  [out, optional] PULONG            pcActualLenContainerName
);

参数

[in] plfoLog

指向表示 CLFS 日志 的 LOG_FILE_OBJECT 结构的指针。 调用方之前通过调用 ClfsCreateLogFile 获取了此指针。

[in] cidLogicalContainer

CLFS 日志中容器的逻辑标识符。

[out] puszContainerName

指向 UNICODE_STRING 结构的指针。 puszContainerName 的 Buffer 成员必须指向接收容器的路径名称的调用方分配的缓冲区。 MaximumLength 成员必须提供缓冲区的大小。

[out, optional] pcActualLenContainerName

指向 ULONG 类型变量的指针，该变量接收容器的路径名称的实际长度（以 Unicode 字符为单位）。 此参数可以为 NULL。

返回值

ClfsGetContainerName 返回 Ntstatus.h 中定义的状态代码之一。 下表提供了各种返回值的含义。

返回代码 说明
STATUS_SUCCESS
 puszContainerName 的 Buffer 成员接收容器的完整路径名称。 如果 pcActualLenContainerName 不为 NULL，它将接收完整路径名称的实际长度（以 Unicode 字符为单位）。
STATUS_BUFFER_OVERFLOW
 完整路径名称的实际长度（以 Unicode 字符为单位）大于 puszContainerName->MaximumLength。 puszContainerName 的 Buffer 成员接收截断为 puszContainerName->MaximumLength 指定的字符数的容器的完整路径名称。 如果 pcActualLenContainerName 不为 NULL，它将接收完整路径名称的实际长度（以 Unicode 字符为单位）。
其他
 返回时， puszContainerName->Buffer 和 pcActualLenContainerName 的内容未定义。

注解

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

要求

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

另请参阅

ClfsAddLogContainer

ClfsRemoveLogContainer