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 |
Library | Clfsw32.lib |
DLL | Clfsw32.dll |