MLSynchronization object

The MLSynchronization object is an abstract class from which MLSync objects are derived.

Properties

MLSynchronization property

Datatype

Description

AdditionalOpts

String

Used to pass additional dbmlsync options.

AuthenticateParms

String

Used with authenticate_parameters connection script.

ErrorText

String

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

ExtendedOpts

String

Extended dbmlsync options.

Host

String

The machine name for the synchronization server.

LogFileName

String

Creates a log file at this path if UseLogFile=true.

LogOpts

String

Additional dbmlsync options to control logging output.

MLPass

String

The MobiLink password passed to the synchronization server.

MLServerVersion

Long

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

MLUser

String

The MobiLink user name passed to the synchronization server.

ObjectRevision

Long

At runtime, if a new ObjectRevision value is detected, the default property values are written to the Windows Registry and used to initialize objects of type 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.

ProcessOption

SyncProcessType (enumerated)

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

ProgressWindowName

String

Name of a user-defined customized window or a window generated by the MobiLink synchronization wizard to indicate synchronization progress.

Publication 

String

The publication to be processed.

SyncRegistryKey

String

Location in the Windows registry where MLSync property values from a previous synchronization are stored.

UseLogFile

Boolean

If true, creates a synchronization log.

UseWindow

Boolean

Used by the synchronization wizard to determine whether to create a progress window to display status information about the synchronization process.

WindowObject

Window

Synchronization progress window.


Events

MLSynchronization event

Occurs

BeginDownload in PowerScript Reference

At the beginning of the download procedure

BeginSync in PowerScript Reference

At the beginning of the synchronization

BeginUpload in PowerScript Reference

At the beginning of the upload procedure

ConnectMobiLink in PowerScript Reference

When the MobiLink synchronization server connects to the consolidated database server

DisconnectMobiLink in PowerScript Reference

Immediately after disconnecting from the synchronization server

DisplayMessage in PowerScript Reference

On display of an informational message

EndDownload in PowerScript Reference

At the end of download processing

EndSync in PowerScript Reference

At the end of synchronization

EndUpload in PowerScript Reference

After transmission of the upload to the synchronization server

ErrorMessage in PowerScript Reference

On display of an error message

FileMessage in PowerScript Reference

On display of a file message

ProgressIndex in PowerScript Reference

Periodically during synchronization after updates to a synchronization progress bar

SyncPreview in PowerScript Reference

Returns generated dbmlsync command arguments immediately prior to launching the process

UploadAck in PowerScript Reference

On completion of upload processing

WaitForUploadAck in PowerScript Reference

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

WarningMessage in PowerScript Reference

On display of a warning message


Functions

MLSynchronization function

Datatype returned

Description

CancelSync in PowerScript Reference

Integer

Cancels a synchronization that is in progress

GetObjectRevisionFromRegistry in PowerScript Reference

Integer

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

GetSyncRegistryProperties in PowerScript Reference

Integer

Retrieves synchronization property values from the Windows registry

SetNewMobiLinkPassword in PowerScript Reference

Integer

Changes the MobiLink password on the consolidated database

SetParm in PowerScript Reference

Integer

Passes SyncParm object properties to a synchronization object

SetSyncRegistryProperties in PowerScript Reference

Integer

Writes synchronization property values to the Windows registry

Synchronize in PowerScript Reference

Integer

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