LogStore.CreateLogArchiveSnapshot Method (SequenceNumber, SequenceNumber)

 

Takes a snapshot of the log store state between the specified sequence numbers for making a backup.

Namespace:   System.IO.Log
Assembly:  System.IO.Log (in System.IO.Log.dll)

public LogArchiveSnapshot CreateLogArchiveSnapshot(
	SequenceNumber first,
	SequenceNumber last
)

Parameters

first
Type: System.IO.Log.SequenceNumber

The starting sequence number in the range to archive.

last
Type: System.IO.Log.SequenceNumber

The ending sequence number in the range to archive.

Return Value

Type: System.IO.Log.LogArchiveSnapshot

A LogArchiveSnapshot object that contains the state necessary to make an archive.

Exception Condition
ArgumentOutOfRangeException

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

ArgumentException

first is larger than last.

InvalidOperationException

An invalid operation has been executed.

IOException

An I/O error occurs when creating the archive snapshot.

NotSupportedException

The log store is not archivable.

ObjectDisposedException

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

OutOfMemoryException

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

SequenceFullException

The record sequence is full.

UnauthorizedAccessException

Access for the specified log store is denied by the operating system.

The archive snapshot returned from this method encompasses information from either the base sequence number or the archive sequence number, whichever is lower, to the last sequence number. It is not inclusive for the last sequence number, which means that the archive only includes records up to but not including last. In addition, when using this method, the start SequenceNumber must be equal to the BaseSequenceNumber in order for the archive to be consistent.

.NET Framework
Available since 3.0
Return to top
Show: