An MLSync object is derived from the MLSynchronization object base class. Its primary function is to launch dbmlsync.exe, a separate process that synchronizes a SQL Anywhere remote database with a consolidated database. The MLSync properties control the options used for the synchronization. MLSync events represent callbacks that are automatically triggered by dbmlsync.exe at specific times during the synchronization process.
|
MLSync property |
Datatype |
Description |
|---|---|---|
|
String |
Used to pass additional dbmlsync options. |
|
|
String |
Used with authenticate_parameters connection script. Equivalent to the -ap "parm1,parm2" dbmlsync option. |
|
|
String |
The ODBC data source name used to connect to a SQL Anywhere remote database. Equivalent to the -c "dsn=myDSN" dbmlsync option, where myDSN is the data source name. |
|
|
String |
Password for the SQL Anywhere remote database. Equivalent to the -c "pwd=myPassword" dbmlsync option, where myPassword is the password for the database connection. |
|
|
String |
User ID for the SQL Anywhere remote database. Equivalent to the -c "uid=myUserID" dbmlsync option, where myUserID is the user ID for the database connection. |
|
|
String |
Encryption key for SQL Anywhere remote database. Equivalent to the -c "dbkey=myKey" dbmlsync option, where myKey is the encryption key for the database. |
|
|
String |
Contains error and diagnostic messages generated when an MLSync function is called incorrectly. |
|
|
String |
Extended dbmlsync options. Equivalent to the -e "extops" dbmlsync option. |
|
|
String |
The machine name for the synchronization server. Equivalent to the -e "adr='host=machineName'" dbmlsync option, where machineName is the host machine. |
|
|
String |
Creates a log file at this path if UseLogFile=true. Equivalent to the -o logfilename dbmlsync option, where logfilename is the full name of the log file you want to create. |
|
|
String |
Additional dbmlsync options to control logging output. |
|
|
String |
The MobiLink password needed to connect to the synchronization server. Equivalent to the -mp password dbmlsync option. |
|
|
Long |
The version of the SQL Anywhere remote database and synchronization server. |
|
|
String |
The MobiLink user name needed to connect to the synchronization server. Equivalent to the -u username dbmlsync option. |
|
|
Long |
You increment this value each time you rebuild the MLSync object with new default property values. At runtime, if a new ObjectRevision value is detected, the default property values are written to the Windows registry and used to initialize MLSync. For subsequent synchronizations, MLSync is initialized using the property values obtained from the Windows registry. |
|
|
String |
The port number for the synchronization server. Equivalent to the -e "adr='port=portno'" dbmlsync option, where portno is the number of the port you use for synchronization. |
|
|
SyncProcessType (enumerated) |
Sets the direction for synchronization. Values are DownloadOnly!, UploadOnly!, and Bidirectional! (default). |
|
|
String |
Specifies the class name of a progress window generated by the MobiLink Synchronization Wizard. The progress window is an optional selection in the synchronization wizard, or a customized user-defined window. It should contain the same callback events as the MLSync object. An MLSync object that is generated by the wizard automatically triggers the appropriate window event in order to display synchronization progress. |
|
|
String |
The publication to be processed. If more than one publication is specified, you must separate each name with a comma. Equivalent to the -n pub1,pub2 dbmlsync option. |
|
|
String |
Location in the Windows registry where MLSync property values from a previous synchronization are stored. The MobiLink Synchronization Wizard generates a synchronization options window that allows an end user to customize the MLSync properties at runtime and save these settings when the SetSyncRegistryProperties function is triggered. |
|
|
Boolean |
If true, creates a synchronization log. |
|
|
Boolean |
Used at runtime by the objects that are generated by the synchronization wizard. When set to true, the generated functions create a progress window to display status information about the synchronization process. |
|
|
Window |
Instance of a synchronization progress window. The class name of WindowObject must match the ProgressWindowName value. |
|
MLSync event |
Occurs |
|---|---|
|
At the beginning of the download procedure |
|
|
Before dbmlsync scans the transaction log to assemble the upload |
|
|
At the beginning of the synchronization |
|
|
At the beginning of the upload procedure |
|
|
When dbmlsync connects to the MobiLink server |
|
|
Immediately after disconnecting from the synchronization server |
|
|
On display of an informational message |
|
|
At the end of download processing |
|
|
After the scan of the transaction log completes for upload |
|
|
At the end of synchronization |
|
|
After transmission of the upload to the synchronization server |
|
|
On display of an error message |
|
|
On display of a file message |
|
|
Periodically whenever the synchronization triggers updates to a progress bar |
|
|
Returns generated dbmlsync command arguments immediately prior to launching the process |
|
|
On completion of upload processing |
|
|
When the synchronization process starts a new waiting period for upload acknowledgement |
|
|
On display of a warning message |
|
MLSync function |
Datatype returned |
Description |
|---|---|---|
|
Integer |
Cancels a synchronization that is in progress |
|
|
String |
Returns the command string that is generated from the current MLSync property values |
|
|
String |
Returns the full path and file name of dbmlsync.exe that is installed on the workstation. |
|
|
Integer |
Returns the current synchronization build number from the Windows registry |
|
|
Integer |
Retrieves the ObjectRevision property saved in the Windows registry by a previous call to SetSyncRegistryProperties |
|
|
Integer |
Changes the MobiLink password on the consolidated database |
|
|
Integer |
Passes SyncParm object properties to an MLSync object |
|
|
Integer |
Writes synchronization property values to the Windows registry |
|
|
Integer |
Launches a synchronization process using the MLSync command string properties that have been set |
