Sync method

Public Function Sync(
    ByVal syncName As String,
    ByVal opts As String
) As UInt32

public UInt32 Sync(String syncName, String opts)

syncName The name of a synchronization profile defined in the remote database that contains the options for the synchronization. If syncName is null then no profile is used and the opts parameter should contain all the options for the synchronization.
opts A string formed according to the same rules used to define an option string for a synchronization profile, which is a string specified as a semicolon delimited list of elements of the form <option name>="">=<option value>="">. If syncName is non-null then the options specified by opts are added to those already in the synchronization profile specified by syncName. If an option in the string already exists in the profile, then the value from the string replaces the value already stored in the profile. If the syncName is null then opts should specify all the options for the synchronization. See CREATE SYNCHRONIZATION PROFILE statement [MobiLink].

An integer value which uniquely identifies this synchronization request and is only valid until the client disconnects from the server. Returns NULL_SYNCHDL if an error prevents the synchronization request from being created. When NULL_SYNCHDL is returned, you can call the GetErrorInfo method for more information about the failure.

You must be connected to the server before calling this method. At least one of syncName and opts must be non-null.

The return value identifies the synchronization request and can be used to cancel the request or to process events returned by the synchronization.

The following C# example demonstrates how to display error codes after invoking the Sync method.

// Insert code to initialize the syncronization client.

UInt32 request = syncClient.Sync("syncName", null);
if (request == DbmlsyncClient.NULL_SYNCHDL) {
    string error_code = syncClient.GetErrorInfo().type.ToString();
    MessageBox.Show(error_code, "Sync Error");
}

GetErrorInfo method

Sync method

Visual Basic syntax

C# syntax

Parameters

Returns

Remarks

See also