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 中定義的其中一個狀態代碼。 下表提供各種傳回值的意義。
傳回碼 | 描述 |
---|---|
|
puszContainerNameBuffer 成員會接收容器的完整路徑名稱。 如果 pcActualLenContainerName 未 NULL,則會接收完整路徑名稱的 Unicode 字元的實際長度。 |
|
完整路徑名稱的實際長度大於 puszContainerName->MaximumLength。 puszContainerName 的 Buffer 成員會接收截斷為 puszContainerName->MaximumLength所指定字元數的容器完整路徑名稱。 如果 pcActualLenContainerName 未 NULL,則會接收完整路徑名稱的 Unicode 字元的實際長度。 |
|
傳回時,未定義 puszContainerName->Buffer 和 pcActualLenContainerName 的內容。 |
言論
如需 CLFS 概念和術語的說明,請參閱 Common Log File System。
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | 適用於 Windows Server 2003 R2、Windows Vista 和更新版本的 Windows。 |
目標平臺 | 桌面 |
標頭 | wdm.h (包括 Wdm.h) |
連結庫 | Clfs.lib |
DLL | Clfs.sys |
IRQL | <= APC_LEVEL |