SqlCeReplication.AddSubscription Method

Creates a new anonymous subscription to an existing Microsoft SQL Server publication. After calling the AddSubscription method, the application must call the Synchronize method to synchronize the new subscription to the publication based on the latest snapshot.

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

public void AddSubscription (
	AddOption addOption
)
public void AddSubscription (
	AddOption addOption
)
public function AddSubscription (
	addOption : AddOption
)

Parameters

addOption

SQL Server Mobile replication only supports anonymous subscriptions.

The database administrator must configure SQL Server to support replication, create the SQL Server publication, and enable the publication for anonymous subscriptions before any SQL Server Mobile application can subscribe to the publication. The administrator does this on the SQL Server system using either the administrative or programmatic interfaces of SQL Server replication.

The AddOption value specifies the source of the newly created SQL Server Mobile subscription database. The value can be one of the following constants:

Value

Description

CreateDatabase

Specifies that the SQL Server Mobile database must first be created, and that the subscription contents are then obtained from the publisher over the network. In this case, the AddSubscription and Synchronize method calls create the SQL Server Mobile database and download the database contents from the SQL Server Publisher.

ExistingDatabase

Specifies that the database already exists, but contents are obtained from the publisher over the network. In this case, the AddSubscription and Synchronize method calls create the SQL Server Mobile subscription and download the database contents from the SQL Server Publisher.

AddOption only affects how the SQL Server Mobile database is initially created and treated by the SQL Server Mobile Client Agent; therefore, determining what data is downloaded to the Windows Mobile device from the server.

This example creates a new subscription database by passing the CreateDatabase value of AddOption when calling the AddSubscription method.

SqlCeReplication repl = null;

try
{
    // Instantiate and configure SqlCeReplication object
    //
    repl = new SqlCeReplication();
    repl.InternetUrl = "http://www.adventure-works.com/sqlmobile/sqlcesa30.dll";
    repl.InternetLogin = "MyInternetLogin";
    repl.InternetPassword = "<password>";
    repl.Publisher = "MyPublisher";
    repl.PublisherDatabase = "MyPublisherDatabase";
    repl.PublisherLogin = "MyPublisherLogin";
    repl.PublisherPassword = "<password>";
    repl.Publication = "MyPublication";
    repl.Subscriber = "MySubscriber";
    repl.SubscriberConnectionString = "Data Source=MyDatabase.sdf";

    // Create a local SQL Mobile Database subscription
    //
    repl.AddSubscription(AddOption.CreateDatabase);

    // Synchronize to the SQL Server database
    //
    repl.Synchronize();

catch (SqlCeException)
{
    // Handle errors here
    //

finally
{
    // Dispose the repl object
    //
    repl.Dispose();


  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show: