getLogContainerName 函式 (clfsw32.h)
擷取指定容器的完整路徑名稱。 此函式主要用於取得呼叫 ScanLogContainers 時所傳回之CLFS_CONTAINER_INFORMATION結構中所參考之容器的完整路徑名稱。
語法
CLFSUSER_API BOOL GetLogContainerName(
[in] HANDLE hLog,
[in] CLFS_CONTAINER_ID cidLogicalContainer,
[in, out] LPCWSTR pwstrContainerName,
[in] ULONG cLenContainerName,
[in, out, optional] PULONG pcActualLenContainerName
);
參數
[in] hLog
從 成功呼叫 CreateLogFile 取得之記錄檔的句柄。
記錄句柄可以參考記錄數據流或實體記錄檔。
[in] cidLogicalContainer
與容器相關聯的唯一標識符。
[in, out] pwstrContainerName
使用者配置緩衝區的指標,以寬字元接收記錄容器的完整路徑和名稱。
[in] cLenContainerName
pwstrContainerName 所指向的緩衝區大小,以字元為單位。
[in, out, optional] pcActualLenContainerName
要接收所擷取之完整容器路徑名稱之實際字元計數的變數指標。
如果函式成功,此參數的值小於或等於 cLenContainerName。 如果緩衝區不夠大,無法儲存整個容器路徑名稱,則函式會失敗並 ERROR_MORE_DATA ,並將此參數設定為完整路徑名稱所需的大小。 若為其他失敗,則不會定義值。
傳回值
如果函式成功,則傳回非零的值。
如果函式失敗,傳回值為零, (0) 。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 下列清單會識別可能的錯誤碼:
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 R2 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | clfsw32.h |
程式庫 | Clfsw32.lib |
Dll | Clfsw32.dll |