GetNextLogArchiveExtent function (clfsw32.h)

Retrieves the next set of archive extents in a log archive context. The log archive context describes a contiguous set of file extents that span the snapshot of the active log captured by PrepareLogArchive captures. GetNextLogArchiveExtent maintains a cursor in the ordered set of log archive descriptors so that subsequent calls allow an application to iterate through the entire set.

Syntax

CLFSUSER_API BOOL GetNextLogArchiveExtent(
  [in]      CLFS_LOG_ARCHIVE_CONTEXT   pvArchiveContext,
  [in, out] CLFS_ARCHIVE_DESCRIPTOR [] rgadExtent,
  [in]      ULONG                      cDescriptors,
  [out]     PULONG                     pcDescriptorsReturned
);

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, out] rgadExtent

A client-allocated array of CLFS_ARCHIVE_DESCRIPTOR structures to be filled in by this function.

[in] cDescriptors

The number of elements in the rgadExtent array.

This value is the maximum number of archive descriptors that can be retrieved by this function.

[out] pcDescriptorsReturned

The number of descriptors in the rgadExtent array that are filled in by this function.

If this value is less than cDescriptors, the set of descriptors is exhausted and the archive client can terminate iteration through the ordered descriptor set. Further calls to this function fail with ERROR_NO_MORE_ENTRIES.

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

CLFS_ARCHIVE_DESCRIPTOR

Common Log File System Functions