BackupDatabase(Stream) Method

In This Topic

Backup the current database to a stream.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub BackupDatabase( _
   ByVal backupStream As System.IO.Stream _
)

'Usage
 
Dim instance As VistaDBConnection
Dim backupStream As System.IO.Stream
 
instance.BackupDatabase(backupStream)

public void BackupDatabase( 
   System.IO.Stream backupStream
)

Parameters

backupStream: An opened and writable System.IO.Stream to write the backed up database to.

Exceptions

Exception	Description
System.ArgumentNullException	If the backupStream is null
System.InvalidOperationException	If the backupStream is not writable
System.InvalidOperationException	If the database is not in a valid open mode for backup.

Remarks

A compressed backup of the currently open database will be made into the provided stream, preserving the encryption of the database (if any). The backup cannot be opened directly and must be restored using the RestoreDatabase(Stream,String,String) method to be operational.

The connection to the database must have the VistaDB.VistaDBDatabaseOpenMode set to ExclusiveReadOnly, ExclusiveReadWrite, or SharedReadOnly to back up the database. This ensures no other process is modifying data while the back up is being performed.

The stream must not add any extra content after the VistaDB backup data but may add a custom prefix of data before calling if this prefix will also be managed upon restoration.

The caller must close and dispose the stream.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

VistaDBConnection Class
VistaDBConnection Members
Overload List

Send Feedback