This topic has not yet been rated - Rate this topic

IRecordSequence.BeginFlush Method

When overridden in a derived class, begins an asynchronous flush operation, using space previously reserved in the sequence.

Namespace:  System.IO.Log
Assembly:  System.IO.Log (in System.IO.Log.dll)
IAsyncResult BeginFlush(
	SequenceNumber sequenceNumber,
	AsyncCallback callback,
	Object state
)

Parameters

sequenceNumber
Type: System.IO.Log.SequenceNumber

The sequence number of the latest record that must be written. If this SequenceNumber is invalid, then all records must be written.

callback
Type: System.AsyncCallback

An optional asynchronous callback, to be called when the flush is complete.

state
Type: System.Object

A user-provided object that distinguishes this particular asynchronous flush request from other requests.

Return Value

Type: System.IAsyncResult
An IAsyncResult that represents the asynchronous flush operation, which could still be pending.
ExceptionCondition
ArgumentException

One or more of the arguments is invalid.

IOException

An I/O error occurred while flushing the data.

ObjectDisposedException

The method was called after the sequence has been disposed of.

You should pass the IAsyncResult returned by the current method to the EndFlush method to ensure that the flush completes and resources are freed appropriately. If an error occurs during an asynchronous flush, an exception is not thrown until the EndFlush method is called with the IAsyncResult returned by this method.

Calling this method ensures that all records that have been appended to the IRecordSequence are durably written.

If a record sequence has been disposed of, or if you pass an invalid argument, exceptions are thrown immediately within this operation. Errors that occurred during an asynchronous flush request, for example, a disk failure during the I/O request, will result in exceptions being thrown when the EndFlush method is called.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.