SqlCeReplication.SubscriberConnectionString Property

Specifies the connection string to the SQL Server Compact Edition database.

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

Syntax

'Declaration
Public Property SubscriberConnectionString As String
'Usage
Dim instance As SqlCeReplication
Dim value As String

value = instance.SubscriberConnectionString

instance.SubscriberConnectionString = value

public string SubscriberConnectionString { get; set; }

public:
property String^ SubscriberConnectionString {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_SubscriberConnectionString ()

/** @property */
public void set_SubscriberConnectionString (String value)

public function get SubscriberConnectionString () : String

public function set SubscriberConnectionString (value : String)

Not applicable.

Property Value

The connection string to the SQL Server Compact Edition database.

Remarks

This property supports all of the ConnectionString properties, except for "persist security info".

Locale Identifier values are supported when creating a new database using the AddSubscription method. Use the Unique LCID for the value of Locale Identifier. To find a list of Unique LCID values, see the Collate topic in the SQL Reference section of the SQL Server Compact Edition Books Online. You must ensure that the locale is supported on the device on which the database is being created.

When specifying the Data Source property of the SubscriberConnectionString, you should include the full path to the database file rather than a relative path.

Example

The following example sets the SubscriberConnectionString property of the SqlCeReplication object.

Dim repl As SqlCeReplication = Nothing

Try
    ' Instantiate and configure SqlCeReplication object
    '
    repl = New SqlCeReplication()
    repl.InternetUrl = "https://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 the local SQL Mobile Database subscription
    '
    repl.AddSubscription(AddOption.CreateDatabase)

    ' Synchronize to the SQL Server to populate the Subscription 
    '
    repl.Synchronize()
Catch
    ' Handle errors here
    '
Finally
    ' Dispose the repl object
    '
    repl.Dispose()
End Try

SqlCeReplication repl = null;

try
{
    // Instantiate and configure SqlCeReplication object
    //
    repl = new SqlCeReplication();
    repl.InternetUrl = "https://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();
}

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