SyncConnect Function (CSWeb)

This page describes the syncconnect function when connecting to a CSWeb server. For generalized information on the function, see the documentation for the syncconnect function.

Format

b = syncconnect(CSWeb,csweb_urlʃ,usernameʃ,passwordʅʅ);

Description

The syncconnect function opens a connection to a CSWeb server to synchronize data and files over the Internet. The first argument must be the keyword CSWeb. The second argument, csweb_url, is a string expression of the full URL of the CSWeb server. The third and fourth arguments, username and password are optional string arguments of the credentials used to login to the server. If the username and password are not specified, the user will be prompted to enter them the first time the synchronization is run. After the credentials have been entered the first time, they are saved in secure storage on the device and do not need to be entered again. You can use the CSPro Settings dialog to clear any cached credentials.

Note: If the attempt to establish an internet connection was unsuccessful, CSPro will alert you with an error message. If you wish to preempt this error message in order to handle this situation on your own, use the Connection Function.

For more information about CSWeb servers, see the Synchronization Overview and the CSWeb help documentation.

Example

string ServerUrl = "https://www.myserver.org/api";

// connect to the CSWeb server
if syncconnect(CSWeb, ServerUrl) then

// send the latest cases to the CSWeb server
syncdata(PUT, SURVEY_DICT);

syncdisconnect();

endif;