StartServer method

public virtual bool StartServer(
    unsigned port,
    const char * cmdline,
    unsigned timeout,
    DBSC_StartType * starttype
)

port The TCP port to check for an existing dbmlsync server. If a new server is started, it is set to listen on this port.
cmdline A valid command line for starting a dbmlsync server. The command line may contain only the following options which have the same meaning that they do for the dbmlsync utility: -a, -c, -dl, -do, -ek, -ep, -k, -l, -o, -os, -ot, -p, -pc+, -pc-, -pd, -pp, -q, -qi, -qc, -sc, -sp, -uc, -ud, -ui, -um, -un, -ux, -v[cnoprsut], -wc, -wh. The -c option must be specified.
timeout The maximum time in milliseconds to wait after a dbmlsync server is started for it to be ready to accept requests. Use DBSC_INFINITY to wait indefinitely for a response.
starttype An out parameter set to indicate if the server has been located or started. If starttype is non-null on entry and StartServer returns true, then, on exit, the variable pointed to by starttype is set to a value from the DBSC_StartType enumeration.

True when the server was already running or successfully started; otherwise, returns false. When false is returned, you can call the GetErrorInfo method for more information about the failure.

If a server is present, this method sets the starttype parameter to DBSC_SS_ALREADY_RUNNING and returns without further action. If no server is found, the method starts a new server using the options specified by the cmdline argument and waits for it to start accepting requests before returning.

On Windows Mobile devices, it is usually necessary to set the server path property before StartServer can be successfully called. The server path property does not need to be set in the following instances:

Your application is in the same directory as dbmlsync.exe.
dbmlsync.exe is in the Windows directory.

DbmlsyncClient.GetErrorInfo method [Dbmlsync C++]

StartServer method

Syntax

Parameters

Returns

Remarks

See also