GetCommandString

Description

Returns the command string sent by dbmlsync to the synchronization server.

Applies to

MLSync controls

Syntax

syncObject.GetCommandString ( )

Argument	Description
syncObject	The name of the MLSync object that starts a synchronization for which you want to get the actual dbmlsync command submitted to the synchronization server.

Returns

String. Returns the command string that is set for submission to the synchronization server. Returns -1 if required properties are missing. (Datasource, Publication, and MLUser, and MLServerVersion are required properties.) When this occurs, a descriptive error is written to the ErrorText property of the MLSync object.

Usage

To minimize confusion to an end user, you might want to hide certain command line arguments in a customized synchronization options window for your MobiLink application. In this case you can call the GetCommandString function to return the command line generated by the options window, then add on values for the options that you hide from the user.

Examples

Example 1

For MLSync objects, you can allow a user to edit the command line arguments for a synchronization call as follows:

long	 rc

string 	cmd

cmd = myMLSync.GetCommandString()

//   Edit cmd however you wish

...

rc = myMLSync.Synchronize(cmd)