IRecordSequence.Flush Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, causes appended records to be written.
Overloads
Flush() |
When overridden in a derived class, ensures that all appended records have been written. |
Flush(SequenceNumber) |
When overridden in a derived class, ensures that all appended records up to and including the record with the specified sequence number have been durably written. |
Flush()
When overridden in a derived class, ensures that all appended records have been written.
public:
System::IO::Log::SequenceNumber Flush();
public System.IO.Log.SequenceNumber Flush ();
abstract member Flush : unit -> System.IO.Log.SequenceNumber
Public Function Flush () As SequenceNumber
Returns
The sequence number of the last record written.
Exceptions
An I/O error occurred while flushing the data.
The method was called after the sequence has been disposed of.
Remarks
Calling this method ensures that all records that have been appended to the IRecordSequence have been durably written.
Applies to
Flush(SequenceNumber)
When overridden in a derived class, ensures that all appended records up to and including the record with the specified sequence number have been durably written.
public:
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
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.
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while flushing the data.
The method was called after the sequence has been disposed of.
Remarks
Calling this method ensures that all records with sequence numbers up to and including the specified sequence number have been durably written.