ReadLogRestartArea function (clfsw32.h)

Returns the last restart area that is written successfully to the log associated with the marshaling area of WriteLogRestartArea. The function also returns a read context that allows the caller to cursor backward or forward through a log from the restart record.

This read context is useful when scanning through previous restart areas prior to the current one by invoking ReadPreviousLogRestartArea.

Syntax

CLFSUSER_API BOOL ReadLogRestartArea(
  [in]                PVOID        pvMarshal,
  [out]               PVOID        *ppvRestartBuffer,
  [out]               PULONG       pcbRestartBuffer,
  [out]               PCLFS_LSN    plsn,
  [out]               PVOID        *ppvContext,
  [in, out, optional] LPOVERLAPPED pOverlapped
);

Parameters

[in] pvMarshal

A pointer to a marshaling context that is allocated by using the CreateLogMarshallingArea function.

[out] ppvRestartBuffer

A pointer to a variable that receives a pointer to the restart data in the log I/O block.

[out] pcbRestartBuffer

A pointer to a variable that receives the amount of restart data.

[out] plsn

A pointer to a CLFS_LSN structure that receives the log sequence number (LSN) of the restart area.

[out] ppvContext

A pointer to a variable that receives a pointer to a system-allocated read context when a read is successful.

If the function defers completion of an operation, it returns a valid read-context pointer and an error status of ERROR_IO_PENDING. On all other errors, the read-context pointer is NULL. For more information about handling deferred completion of the function, see the Remarks section of this topic.

After obtaining all requested log records, the client must pass the read context to TerminateReadLog to free the associated memory. Failure to do so results in memory leakage.

[in, out, optional] pOverlapped

A pointer to an OVERLAPPED structure that is required for asynchronous operation.

This parameter can be NULL if an asynchronous operation is not used.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

The following list identifies the possible error codes:

Remarks

The error message ERROR_LOG_BLOCK_INCOMPLETE is returned if the log block size specified by CreateLogMarshallingArea is not large enough to hold a complete log block.

Typically, ReadLogRestartArea is used only during client restart, either after a crash or after a normal shutdown.

If there is no restart area in the log, ReadLogRestartArea fails with the code ERROR_LOG_NO_RESTART.

If ReadLogRestartArea fails with an error code of ERROR_IO_PENDING, a pointer to a valid read context is placed in the variable pointed to by the ppvReadContext parameter.

To complete the log-record copy, the client should first synchronize its execution with deferred completion of the overlapped I/O operation by calling GetOverlappedResult, or one of the synchronization Wait Functions. For more information, see Synchronization and Overlapped Input and Output.

After ReadLogRestartArea completes asynchronously, the requested restart area is read from the disk, but a valid pointer to it is not placed in *ppvRestartBuffer.

To obtain a valid pointer, the client must call ReadPreviousLogRestartArea, which passes in the read-context pointer returned by ReadLogRestartArea.

Requirements

See also

CLFS_LSN

Common Log File System Functions

CreateLogFile

OVERLAPPED

ReadPreviousLogRestartArea

Synchronization and Overlapped Input and Output

WriteLogRestartArea