ReadLogArchiveMetadata 函数 (clfsw32.h)

将元数据的存档视图范围复制到指定的缓冲区。

语法

CLFSUSER_API BOOL ReadLogArchiveMetadata(
  [in]      CLFS_LOG_ARCHIVE_CONTEXT pvArchiveContext,
  [in]      ULONG                    cbOffset,
  [in]      ULONG                    cbBytesToRead,
  [in, out] PBYTE                    pbReadBuffer,
  [out]     PULONG                   pcbBytesRead
);

参数

[in] pvArchiveContext

指向通过调用 PrepareLogArchive 获取的存档上下文的指针。

上下文维护游标状态，该状态允许通过存档中的文件盘区集进行迭代。 存档客户端负责使用 TerminateLogArchive 函数解除分配上下文。

[in] cbOffset

数据复制开始的元数据中的偏移量。

首次调用此函数时，) 指定零 (0。 在后续调用中，指定 在板读取中返回的值。

[in] cbBytesToRead

元数据快照的字节数应复制到 pbReadBuffer 中。

此参数不能为零 (0) 。

[in, out] pbReadBuffer

指向复制元数据快照的缓冲区的指针。

[out] pcbBytesRead

指向变量的指针，该变量接收复制到 pbReadBuffer 的字节数。

字节数始终介于零 (0) 和 cbBytesToRead 之间。

返回值

如果该函数成功，则返回值为非零值。

如果函数失败，则返回值为零 (0)。 要获得更多的错误信息，请调用 GetLastError。 以下列表标识了可能的错误代码：

要求

另请参阅

常见日志文件系统函数

PrepareLogArchive

TerminateLogArchive