GetCommandString PowerScript function
Description
Returns the
command string sent by dbmlsync to the synchronization
server.
Controls
MLSync controls
Syntax
|
1 |
<span>syncObject</span>.<span>GetCommandString</span> (<span> </span>) |
|
Argument |
Description |
|---|---|
|
syncObject |
The name of the MLSync object that starts |
Return Values
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
For MLSync objects, you can allow a user to edit
the command line arguments for a synchronization call as follows:
|
1 |
long rc |
|
1 |
string cmd |
|
1 |
cmd = myMLSync.<span>GetCommandString</span>() |
|
1 |
// Edit cmd however you wish |
|
1 |
... |
|
1 |
rc = myMLSync.Synchronize(cmd) |