LogArchiveSnapshot Class

Represents a snapshot of the LogStore instance that can be used to generate an archive.

Namespace: System.IO.Log
Assembly: System.IO.Log (in system.io.log.dll)

public sealed class LogArchiveSnapshot
public final class LogArchiveSnapshot
public final class LogArchiveSnapshot
Not applicable.

A LogArchiveSnapshot object contains the information necessary to generate a consistent backup of the data in a LogStore. The actual data is contained in the enumerable collection of FileRegion objects returned by the ArchiveRegions property. Each FileRegion instance represents a sequence of bytes in a file that must be archived.

The ArchiveTail, BaseSequenceNumber, and LastSequenceNumber properties are for informational purposes only. They can be recorded along with the archive data to provide optional information, but are not required to restore the data.

The following example shows how to use the LogArchiveSnapshot class to archive a LogStore to an XML document.

class LogBackup
    static void ArchiveToXML(LogStore logStore, string fileName) 
        LogArchiveSnapshot snapshot = logStore.CreateLogArchiveSnapshot();
        XmlTextWriter writer = new XmlTextWriter(fileName, Encoding.ASCII);
        foreach(FileRegion region in snapshot.ArchiveRegions) 
            writer.WriteElementString("path", region.Path); 
            writer.WriteElementString("length", region.FileLength.ToString()); 
            writer.WriteElementString("offset", region.Offset.ToString()); 
            using(Stream dataStream = region.GetStream()) 
                byte[] data = new byte[dataStream.Length]; 
                dataStream.Read(data, 0, data.Length); 
                writer.WriteElementString("data", Convert.ToBase64String(data)); 
    static void RestoreFromXML(string fileName) 
        using(XmlTextReader reader = new XmlTextReader(fileName)) 
                string path = reader.ReadElementString("path"); 
                long length = Int64.Parse(reader.ReadElementString("length")); 
                long offset = Int64.Parse(reader.ReadElementString("offset")); 
                string dataString = reader.ReadElementString("data"); 
                byte[] data = Convert.FromBase64String(dataString); 
                FileStream fileStream;
                using(fileStream = new FileStream(path, FileMode.OpenOrCreate, FileAccess.Write)) 
                    fileStream.Position = offset; fileStream.Write(data, 0, data.Length); 


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions