Edit

Share via


FileRecordSequence.Flush Method

Definition

Causes appended records to be durably written.

Overloads

Flush()

Ensures that all appended records have been written. This method cannot be inherited.

Flush(SequenceNumber)

Ensures that all appended records have been written. This method cannot be inherited.

Flush()

Ensures that all appended records have been written. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber Flush();
public System.IO.Log.SequenceNumber Flush ();
abstract member Flush : unit -> System.IO.Log.SequenceNumber
override this.Flush : unit -> System.IO.Log.SequenceNumber
Public Function Flush () As SequenceNumber

Returns

The sequence number of the last record written.

Implements

Exceptions

An I/O error occurred while flushing the data.

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

There is not enough memory to continue the execution of the program.

Remarks

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

Applies to

Flush(SequenceNumber)

Ensures that all appended records have been written. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber Flush(System::IO::Log::SequenceNumber sequenceNumber);
public System.IO.Log.SequenceNumber Flush (System.IO.Log.SequenceNumber sequenceNumber);
abstract member Flush : System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
override this.Flush : System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
Public Function Flush (sequenceNumber As SequenceNumber) As SequenceNumber

Parameters

sequenceNumber
SequenceNumber

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

Returns

The sequence number of the last record written.

Implements

Exceptions

sequenceNumber is not between the base and last sequence numbers of this sequence.

sequenceNumber is not valid for this sequence.

An I/O error occurred while flushing the data.

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

There is not enough memory to continue the execution of the program.

Remarks

Calling this method ensures that all records with sequence numbers up to and including the specified sequence number have been durably written.

Applies to