SqlCeReplication.DropSubscription Method

Article
10/22/2009

Drops the subscription to a SQL Server publication and optionally deletes the SQL Server Compact 3.5 SP1 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 _
)

public void DropSubscription (
    DropOption dropOption
)

public:
void DropSubscription (
    DropOption dropOption
)

public void DropSubscription (
    DropOption dropOption
)

public function DropSubscription (
    dropOption : DropOption
)

Parameters

dropOption

Remarks

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

Item	Description
DropDatabase	Deletes the SQL Server Compact 3.5 SP1 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();
}

Thread Safety

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

Platforms

Development Platforms

Windows Vista, Windows Mobile 5.0, Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Mobile 2003 for Pocket PC, Windows CE 5.0
Version Information
.NET Framework and NET Compact Framework
Supported in 3.5
.NET Framework
Supported in 3.0
.NET Compact Framework and .Net Framework
Supported in 2.0