GetNextLogArchiveExtent 函数 (clfsw32.h)
检索日志存档上下文中的下一组存档区。 日志存档上下文描述一组连续的文件区,这些范围跨越 PrepareLogArchive 捕获捕获的活动日志快照。 GetNextLogArchiveExtent 在日志存档描述符的有序集中维护游标,以便后续调用允许应用程序循环访问整个集。
语法
CLFSUSER_API BOOL GetNextLogArchiveExtent(
[in] CLFS_LOG_ARCHIVE_CONTEXT pvArchiveContext,
[in, out] CLFS_ARCHIVE_DESCRIPTOR [] rgadExtent,
[in] ULONG cDescriptors,
[out] PULONG pcDescriptorsReturned
);
参数
[in] pvArchiveContext
指向通过调用 PrepareLogArchive 获取的存档上下文的指针。
上下文维护游标状态,允许通过存档中的文件区集进行迭代。 存档客户端负责使用 TerminateLogArchive 函数解除分配上下文。
[in, out] rgadExtent
此函数要填充 的CLFS_ARCHIVE_DESCRIPTOR 结构的客户端分配数组。
[in] cDescriptors
rgadExtent 数组中的元素数。
此值是此函数可以检索的最大存档描述符数。
[out] pcDescriptorsReturned
此函数填充的 rgadExtent 数组中的描述符数。
如果此值小于 cDescriptors,则描述符集将用尽,存档客户端可以通过有序描述符集终止迭代。 对此函数的进一步调用失败,并ERROR_NO_MORE_ENTRIES。
返回值
如果该函数成功,则返回值为非零值。
如果函数失败,则返回值为零 (0)。 要获得更多的错误信息,请调用 GetLastError。 以下列表标识了可能的错误代码:
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 R2 [仅限桌面应用] |
目标平台 | Windows |
标头 | clfsw32.h |
Library | Clfsw32.lib |
DLL | Clfsw32.dll |