FlushLogToLsn function

Forces all records appended to this marshaling area up to the record with the specified log sequence number (LSN) to be flushed to the disk. More records than specified may be flushed during this operation.

Syntax


BOOL WINAPI FlushLogToLsn(
  _In_        PVOID        pvMarshalContext,
  _In_        PCLFS_LSN    plsnFlush,
  _Out_opt_   PCLFS_LSN    plsnLastFlushed,
  _Inout_opt_ LPOVERLAPPED pOverlapped
);

Parameters

pvMarshalContext [in]

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

plsnFlush [in]

A pointer to a CLFS_LSN structure that specifies the LSN that is used to determine which records to flush.

Specify CLFS_LSN_NULL to flush all records in the marshaling area.

plsnLastFlushed [out, optional]

A pointer to a CLFS_LSN structure.

The LSN returned is greater than the LSN of any record flushed. If the function succeeds, the value of the LSN is never less than plsnFlush. This value is meaningful only when the function succeeds.

pOverlapped [in, out, optional]

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

This parameter can be NULL except for an asynchronous operation.

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_IO_DEVICE
ERROR_IO_PENDING

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

CLFS_LSN
Common Log File System Functions
OVERLAPPED

 

 

Community Additions

ADD
Show: