Skip to content

Latest commit

 

History

History
81 lines (63 loc) · 3.29 KB

nf-txlogpub-ilog-force.md

File metadata and controls

81 lines (63 loc) · 3.29 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:txlogpub.ILog.Force
ILog::Force (txlogpub.h)
Forces the contents of the log to disk, at least up through the specified LSN.
Force
Force method [COM]
Force method [COM]
ILog interface
ILog interface [COM]
Force method
ILog.Force
ILog::Force
_com_ilog_force
com.ilog_force
txlogpub/ILog::Force
com\ilog_force.htm
com
91df6049-37ce-4a46-b401-9af7d9c09f14
12/05/2018
Force, Force method [COM], Force method [COM],ILog interface, ILog interface [COM],Force method, ILog.Force, ILog::Force, _com_ilog_force, com.ilog_force, txlogpub/ILog::Force
txlogpub.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Txlogpub.idl
Windows
19H1
ILog::Force
txlogpub/ILog::Force
c++
APIRef
kbSyntax
COM
Txlogpub.h
ILog.Force

ILog::Force

-description

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

-parameters

-param lsnMinToForce [in]

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.

-returns

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.

-see-also

FlushFileBuffers

ILog