ULSyncParms class

UL Ext: Represents synchronization parameters that define how to synchronize an UltraLite database.

Visual Basic syntax

Public NotInheritable Class ULSyncParms

C# syntax

public sealed class ULSyncParms

Members

All members of the ULSyncParms class, including all inherited members.

Name	Description
CopyFrom method	Copies the properties of the specified ULSyncParms object to this ULSyncParms object.
ToString method	Returns the string representation of this instance.
AdditionalParms property	Specifies additional synchronization parameters as a semicolon-separated list of name=value pairs.
AuthenticationParms property	Specifies parameters for a custom user authentication script (MobiLink authenticate_parameters connection event).
DownloadOnly property	Specifies whether to disable or enable uploads when synchronizing.
KeepPartialDownload property	Specifies whether to disable or enable partial downloads when synchronizing.
NewPassword property	Specifies a new MobiLink password for the user specified with UserName.
Password property	The MobiLink password for the user specified by UserName.
PingOnly property	Specifies whether the client should only ping the MobiLink server instead of performing a real synchronization.
Publications property	Specifies the publications to be synchronized.
ResumePartialDownload property	Specifies whether to resume or discard a previous partial download.
SendDownloadAck property	Specifies whether the client should send a download acknowledgement to the MobiLink server during synchronization.
Stream property	Specifies the MobiLink synchronization stream to use for synchronization.
StreamParms property	Specifies the parameters to configure the synchronization stream.
UploadOnly property	Specifies whether to disable or enable downloads when synchronizing.
UserName property	The user name that uniquely identifies the MobiLink client to the MobiLink server.
Version property	Specifies which synchronization script to use.

Remarks

There is no constructor for this class. Each connection has its own ULSyncParms instance, attached as its ULConnection.SyncParms property.

At most, only one synchronization command (the ULSyncParms.DownloadOnly, ULSyncParms.PingOnly, ULSyncParms.ResumePartialDownload, or ULSyncParms.UploadOnly property) can be specified at a time. If more than one of these parameters is set to true, a ULSQLCode.SQLE_SYNC_INFO_INVALID SQLException is thrown by the ULConnection.Synchronize method.

Other sources of ULSQLCode.SQLE_SYNC_INFO_INVALID errors include not specifying a ULSyncParms.Stream value or a ULSyncParms.Version value.