Objects and Controls
System Object Properties, Events, and Functions

AdditionalOpts

String

Used to pass additional dbmlsync options.

AuthenticateParms

String

Used with authenticate_parameters connection script. Equivalent to the -ap "parm1,parm2" dbmlsync option.

DataSource

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.

DBPass

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.

DBUser

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.

EncryptionKey

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.

ErrorText

String   

Contains error and diagnostic messages generated when an MLSync function is called incorrectly.

ExtendedOpts

String

Extended dbmlsync options. Equivalent to the -e "extops" dbmlsync option.

Host

String

The machine name for the synchronization server. Equivalent to the -e "adr='host=machineName'" dbmlsync option, where machineName is the host machine.

LogFileName

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.

LogOpts

String

Additional dbmlsync options to control logging output.

MLPass

String

The MobiLink password needed to connect to the synchronization server. Equivalent to the -mp password dbmlsync option.

MLServerVersion

Long

The version of the SQL Anywhere remote database and synchronization server.

MLUser

String

The MobiLink user name needed to connect to the synchronization server. Equivalent to the -u username dbmlsync option.

ObjectRevision

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.

Port

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.

ProcessOption

SyncProcessType (enumerated)

Sets the direction for synchronization. Values are DownloadOnly!, UploadOnly!, and Bidirectional! (default).

ProgressWindowName

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.

Publication

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.

SyncRegistryKey

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.

UseLogFile

Boolean

If true, creates a synchronization log.

UseWindow

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.

WindowObject

Window

Instance of a synchronization progress window. The class name of WindowObject must match the ProgressWindowName value.

BeginDownload

At the beginning of the download procedure

BeginLogScan

Before dbmlsync scans the transaction log to assemble the upload

BeginSync

At the beginning of the synchronization

BeginUpload

At the beginning of the upload procedure

ConnectMobiLink

When dbmlsync connects to the MobiLink server

DisconnectMobiLink

Immediately after disconnecting from the synchronization server

DisplayMessage

On display of an informational message

EndDownload

At the end of download processing

EndLogScan

After the scan of the transaction log completes for upload

EndSync

At the end of synchronization

EndUpload

After transmission of the upload to the synchronization server

ErrorMessage

On display of an error message

FileMessage

On display of a file message

ProgressIndex

Periodically whenever the synchronization triggers updates to a progress bar

SyncPreview

Returns generated dbmlsync command arguments immediately prior to launching the process

UploadAck

On completion of upload processing

WaitForUploadAck

When the synchronization process starts a new waiting period for upload acknowledgement

WarningMessage

On display of a warning message

CancelSync

Integer

Cancels a synchronization that is in progress

GetCommandString

String

Returns the command string that is generated from the current MLSync property values

GetDbmlsyncPath

String

Returns the full path and file name of dbmlsync.exe that is installed on the workstation.

GetObjectRevisionFromRegistry

Integer

Returns the current synchronization build number from the Windows registry

GetSyncRegistryProperties

Integer

Retrieves the ObjectRevision property saved in the Windows registry by a previous call to SetSyncRegistryProperties

SetNewMobiLinkPassword

Integer

Changes the MobiLink password on the consolidated database

SetParm

Integer

Passes SyncParm object properties to an MLSync object

SetSyncRegistryProperties

Integer

Writes synchronization property values to the Windows registry

Synchronize

Integer

Launches a synchronization process using the MLSync command string properties that have been set