ILog::Force method (txlogpub.h)

Article
02/22/2024

Forces the contents of the log to disk, at least up through the specified LSN.

Syntax

HRESULT Force(
  [in] LSN lsnMinToForce
);

Parameters

[in] lsnMinToForce

At the very least, all records that have not yet been written to disk with an LSN less than or equal to lsnMinToForce must be written to disk now. An implementation may, however, choose to write more records than what is strictly required. For example, an implementation is allowed to force all records to disk, regardless of the value of lsnMinToForce. Passing 0 as lsnMinToForce indicates that the entire log is to be forced to disk.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The log may also be forced to disk after appending individual records. See ILog::AppendRecord.

Notes to Callers

A failure return value indicates that any records appended to the log since the last time it was successfully forced are not guaranteed to be on disk. The ILog interface does not provide a method to determine which records have been successfully written to disk. If you need to know which records were successfully written to disk, you must force the log for each record. See ILog::AppendRecord.

Notes to Implementers

It is recommended that you flush file buffers (for example, using the FlushFileBuffers function) before returning from this method.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	txlogpub.h