共用方式為

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 中定義的其中一個狀態代碼。 下表提供各種傳回值的意義。

傳回碼 Description
STATUS_SUCCESS
 puszContainerName 的 Buffer 成員會收到容器的完整路徑名稱。 如果 pcActualLenContainerName 不是 NULL，它會在 Unicode 字元中接收完整路徑名稱的實際長度。
STATUS_BUFFER_OVERFLOW
 完整路徑名稱的實際長度大於 puszContainerName->MaximumLength。 puszContainerName 的 Buffer 成員會接收截斷為 puszContainerName->MaximumLength 所指定字元數目的容器完整路徑名稱。 如果 pcActualLenContainerName 不是 NULL，它會在 Unicode 字元中接收完整路徑名稱的實際長度。
其他
 傳回時， puszContainerName->Buffer 和 pcActualLenContainerName 的內容未定義。

備註

如需CLFS概念和術語的說明，請參閱 一般記錄檔系統。

規格需求

需求 值
最低支援的用戶端 可在 Windows Server 2003 R2、Windows Vista 和更新版本的 Windows 中使用。
目標平台 桌面
標頭 wdm.h (包含 Wdm.h)
程式庫 Clfs.lib
Dll Clfs.sys
IRQL <= APC_LEVEL

另請參閱

ClfsAddLogContainer

ClfsRemoveLogContainer