SqlCeReplication.DropSubscription Method

  • Article

Drops the subscription to a SQL Server publication and optionally deletes the SQL Server Compact Edition database from the Windows Mobile-based device.

Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in system.data.sqlserverce.dll)

Syntax

'Declaration
Public Sub DropSubscription ( _
    dropOption As DropOption _
)
'Usage
Dim instance As SqlCeReplication
Dim dropOption As DropOption

instance.DropSubscription(dropOption)

public void DropSubscription (
    DropOption dropOption
)

public:
void DropSubscription (
    DropOption dropOption
)

public void DropSubscription (
    DropOption dropOption
)

public function DropSubscription (
    dropOption : DropOption
)

Not applicable.

Parameters

  • dropOption

Remarks

The DropOption value specifies whether to leave or delete the SQL Server Compact Edition database. The value can be one of the following constants:

Item

Description

DropDatabase

Deletes the SQL Server Compact Edition database (default).

LeaveDatabase

Deletes the replication system tables and three replication system columns in the user tables, but does not delete the database.

Example

The following example shows how to drop a subscription and delete the local database. A SqlCeReplication object is created, the SubscriberConnectionString is set, and the DropSubscription method is called. This method passes the DropDatabase option.

Dim repl As SqlCeReplication = Nothing

Try
    ' Create SqlCeReplication instance
    '
    repl = New SqlCeReplication()
    repl.SubscriberConnectionString = "Data Source=MyDatabase.sdf"

    ' Drop the subscription and delete the database
    '
    repl.DropSubscription(DropOption.DropDatabase)
Catch
    ' Handle errors here
Finally
    ' Dispose the repl object
    '
    repl.Dispose()
End Try

SqlCeReplication repl = null;

try
{
    // Create SqlCeReplication instance
    //
    repl = new SqlCeReplication();
    repl.SubscriberConnectionString = "Data Source=MyDatabase.sdf";

    // Drop the subscription and delete the database
    //
    repl.DropSubscription(DropOption.DropDatabase);
}
catch (SqlCeException)
{
    // Handle errors here
}
finally
{
    // Dispose the repl object
    //
    repl.Dispose();
}

Platforms

Windows CE, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows XP Professional x64 Edition, Windows XP SP2

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

Version Information

.NET Framework

Supported in: 3.0

.NET Compact Framework

Supported in: 2.0, 1.0

See Also

Reference

SqlCeReplication Class
SqlCeReplication Members
System.Data.SqlServerCe Namespace