Contents Index Synchronization Parameters Reference auth_parms parameter

UltraLite Static C++ User's Guide
  Synchronization Parameters Reference

Synchronization parameters


The synchronization parameters are members of a structure that is provided as an argument in the call to synchronize. The ul_synch_info structure that holds the synchronization parameters is defined in ulglobal.h as follows:

struct ul_synch_info {
    ul_char *             user_name;
    ul_char *             password;
    ul_char *             new_password;
    ul_char *             version;
    p_ul_stream_defn      stream;
    ul_char *             stream_parms;
    p_ul_stream_defn      security;
    ul_char *             security_parms;
    ul_synch_observer_fn  observer;
    ul_void *             user_data;
    ul_publication_mask   publication;
    ul_bool               upload_only;
    ul_bool               download_only;
    ul_bool               send_download_ack;
    ul_bool               send_column_names;
    ul_bool               ping;
    ul_bool               checkpoint_store;
    ul_bool               disable_concurrency;
    ul_byte               num_auth_params;
    ul_char * *           auth_parms;

    // fields set on output
    ul_stream_error       stream_error;
    ul_bool               upload_ok;
    ul_bool               ignored_rows;
    ul_auth_status        auth_status;
    ul_s_long             auth_value;

    p_ul_synch_info       init_verify;
};

The init_verify field is reserved for internal use.

Use UL_TEXT around constant strings 
The UL_TEXT macro allows constant strings to be compiled as single-byte strings or wide-character strings. Use this macro to enclose all constant strings supplied as members of the ul_synch_info structure so that the compiler handles these parameters correctly.

For a description of the role of each synchronization parameter, see Synchronization parameters.


auth_parms parameter
auth_status parameter
auth_value synchronization parameter
checkpoint_store synchronization parameter
disable_concurrency synchronization parameter
download_only synchronization parameter
ignored_rows synchronization parameter
new_password synchronization parameter
num_auth_parms parameter
observer synchronization parameter
password synchronization parameter
ping synchronization parameter
publication synchronization parameter
security synchronization parameter
security_parms synchronization parameter
send_column_names synchronization parameter
send_download_ack synchronization parameter
stream synchronization parameter
stream_error synchronization parameter
stream_parms synchronization parameter
upload_ok synchronization parameter
upload_only synchronization parameter
user_data synchronization parameter
user_name synchronization parameter
version synchronization parameter

Contents Index Synchronization Parameters Reference auth_parms parameter