MLSynchronization object – PB Docs 2019

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.

BeginDownload

At the beginning of the download
procedure

BeginSync

At the beginning of the
synchronization

BeginUpload

At the beginning of the upload
procedure

ConnectMobiLink

When the MobiLink synchronization server connects
to the consolidated database server

DisconnectMobiLink

Immediately after disconnecting from the
synchronization server

DisplayMessage

On display of an informational
message

EndDownload

At the end of download processing

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 during synchronization after updates
to a synchronization 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

GetObjectRevisionFromRegistry

Integer

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

GetSyncRegistryProperties

Integer

Retrieves synchronization property values from the
Windows registry

SetNewMobiLinkPassword

Integer

Changes the MobiLink password on the consolidated
database

SetParm

Integer

Passes SyncParm object properties to a
synchronization object

SetSyncRegistryProperties

Integer

Writes synchronization property values to the
Windows registry

Synchronize

Integer

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