DropSubscription Method

Drops the subscription to a publication and optionally deletes the database from the -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
)
member DropSubscription : 
        dropOption:DropOption -> unit 
public function DropSubscription(
    dropOption : DropOption
)

Parameters

Remarks

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

Item

Description

DropDatabase

Deletes the database (default).

LeaveDatabase

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

Examples

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();
}

See Also

Reference

SqlCeReplication Class

SqlCeReplication Members

System.Data.SqlServerCe Namespace