SqlCeReplication.LoadProperties Method

Article
10/22/2009

Retrieves all values stored for the synchronization properties, and then populates the SqlCeReplication class properties with these saved values.

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

Syntax

'Declaration
Public Function LoadProperties As Boolean

public bool LoadProperties ()

public:
bool LoadProperties ()

public boolean LoadProperties ()

public function LoadProperties () : boolean

Remarks

For the LoadProperties function to succeed, you must provide all of the SqlCeReplication object properties unless the database specified in the SubscriberConnectionString has only one subscription. If the database subscribes to only one publication, you can omit the following properties:

If LoadProperties is called without setting these properties, and more than one subscription exists in the database, an error is raised for each subscription in the database. Each error in the collection contains the string parameters of the Publisher, Publication, and PublisherDatabase properties for each subscription in the database.

When SaveProperties is called, the values for the password properties are stored in the database. These values are automatically encrypted with the unique device hardware key. Therefore, if you create a subscription profile on one device (or a server), and then copy the database to a new device, LoadProperties will fail to retrieve the password from the profile. You can provide the correct password manually and then call SaveProperties again to persist the profile on the new device.

Example

The following example shows how to use the LoadProperties method.

Try
    '
    'NOTE: when possible, prompt users to enter security 
    'credentials at runtime. If you store credentials in a file, 
    'you must secure the file to prevent unauthorized access.
    '
    Dim repl As New SqlCeReplication()
    repl.SubscriberConnectionString = "Data Source='Test.sdf'; Pwd='<enterStrongPassword>'"
    repl.LoadProperties()

    repl.Synchronize()
Catch
    ' Handle errors here
End Try

try
{
    //NOTE: when possible, prompt users to enter security 
    //credentials at runtime. If you store credentials in a file, 
    //you must secure the file to prevent unauthorized access.
    //
    SqlCeReplication repl = new SqlCeReplication();
    repl.SubscriberConnectionString = "Data Source='Test.sdf'; Pwd='<enterStrongPassword>'";
    repl.LoadProperties();

    repl.Synchronize();
}
catch (SqlCeException)
{
    // Handle errors here
}

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