ReadLogArchiveMetadata function (clfsw32.h)

Copies a range of the archive view of the metadata to the specified buffer.

Syntax

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

Parameters

[in] pvArchiveContext

A pointer to an archive context that is obtained by a call to PrepareLogArchive.

The context maintains the cursor state, which allows iteration through the set of file extents in the archive. The archive client is responsible for deallocating the context by using the TerminateLogArchive function.

[in] cbOffset

The offset in the metadata where data copying starts.

On the first call to this function, specify zero (0). On subsequent calls, specify the value that is returned in pcbBytesRead.

[in] cbBytesToRead

The number of bytes of the metadata snapshot should be copied into pbReadBuffer.

This parameter cannot be zero (0).

[in, out] pbReadBuffer

A pointer to the buffer where the metadata snapshot is copied.

[out] pcbBytesRead

A pointer to a variable that receives the number of bytes that are copied to pbReadBuffer.

The number of bytes is always between zero (0) and cbBytesToRead.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, call GetLastError. The following list identifies the possible error codes:

Requirements

See also

Common Log File System Functions

PrepareLogArchive

TerminateLogArchive