a_sync_db structure

typedef struct a_sync_db

Member name	Type	Description
allow_outside_connect	a_bit_field	Reserved; use 0.
allow_schema_change	a_bit_field	Set TRUE to check for schema changes between synchronizations. Equivalent to the dbmlsync -sc option.
apply_dnld_file	const char *	Name of download file to apply. Equivalent to dbmlsync -ba option or NULL if option not specified.
argv	char **	The argv array for this run, the last element of the array must be NULL.
autoclose	a_bit_field	Set TRUE to close window on completion. Equivalent to the dbmlsync -qc option.
background_retry	a_sql_int32	Number of times to retry an interrupted background synchronization. Equivalent to the dbmlsync -bkr option.
background_sync	a_bit_field	Set TRUE to do a background synchronization. Equivalent to the dbmlsync -bk option.
cache_verbosity	a_bit_field	Reserved; use 0.
ce_argv	char **	Reserved; use NULL.
ce_reproc_argv	char **	Reserved; use NULL.
changing_pwd	a_bit_field	Set TRUE when setting a new MobiLink password. See new_mlpassword field. Equivalent to the dbmlsync -mn option.
confirmrtn	MSG_CALLBACK	Address of a confirmation request callback routine or NULL.
connectparms	char *	Parameters needed to connect to the database. They take the form of connection strings, such as the following: "UID=DBA;PWD=sql;DBF=demo.db". The database server would be started by the connection string START parameter. For example: "START=c:\SQLAny12\bin32\dbeng12.exe". A full example connection string including the START parameter: "UID=DBA;PWD=sql;DBF=demo.db;START=c:\SQLAny12\bin32\dbeng12.exe".
connectparms_allocated	a_bit_field	Reserved; use 0.
continue_download	a_bit_field	Set TRUE to continue a previously failed download. Equivalent to the dbmlsync -dc option.
create_dnld_file	const char *	Name of download file to create. Equivalent to dbmlsync -bc option or NULL if switch not specified.
debug	a_bit_field	Reserved; use 0.
debug_dump_char	a_bit_field	Reserved; use 0.
debug_dump_hex	a_bit_field	Reserved; use 0.
debug_dump_size	a_sql_uint32	Reserved; use 0.
debug_page_offsets	a_bit_field	Reserved; use 0.
default_window_title	char *	Name of the program to display in the window caption (for example, DBMLSync).
dl_insert_width	a_sql_uint32	Reserved; use 0.
dl_use_put	a_bit_field	Reserved; use 0.
dlg_info_msg	a_sql_uint32	Reserved; use 0.
dnld_fail_len	a_sql_uint32	Reserved; use 0.
dnld_file_extra	const char *	Specify extra string to include in download file. Equivalent to dbmlsync -be option.
dnld_gen_num	a_bit_field	Set TRUE to update generation number when download file is applied. Equivalent to the dbmlsync -bg option.
dnld_read_size	a_sql_uint32	Set the download read size. Equivalent to the dbmlsync -drs option.
download_only	a_bit_field	Set TRUE to perform download-only synchronization. Equivalent to the dbmlsync -ds option.
encrypted_stream_opts	const char *	Reserved; use NULL.
encryption_key	char *	The encryption key for the database file. Equivalent to the dbmlsync -ek option.
entered_dialog	a_bit_field	Reserved; use 0.
errorrtn	MSG_CALLBACK	Address of an error message callback routine or NULL.
est_upld_row_cnt	a_sql_uint32	Set the estimated upload row count (for optimization). Equivalent to the dbmlsync -urc option.
extended_options	char *	Extended options in the form "keyword=value;...". Equivalent to dbmlsync -e option.
hide_conn_str	a_bit_field	Set FALSE to show connect string, TRUE to hide the connect string. Equivalent to the dbmlsync -vc option.
hide_ml_pwd	a_bit_field	Set FALSE to show MobiLink password, TRUE to hide the MobiLink password. Equivalent to the dbmlsync -vp option.
hovering_frequency	a_sql_uint32	Set the logscan polling period in seconds. Usually 60. Equivalent to the dbmlsync -pp option.
ignore_debug_interrupt	a_bit_field	Reserved; use 0.
ignore_hook_errors	a_bit_field	Set TRUE to ignore errors that occur in hook functions. Equivalent to the dbmlsync -eh option.
ignore_hovering	a_bit_field	Set TRUE to disable logscan polling. Equivalent to the dbmlsync -p option.
ignore_scheduling	a_bit_field	Set TRUE to ignore scheduling. Equivalent to the dbmlsync -is option.
include_scan_range	const char *	Reserved; use NULL.
init_cache	a_sql_uint32	Initial size for cache. Equivalent to the dbmlsync -ci option.
init_cache_suffix	char	Suffix for initial cache size ('B' for bytes, 'P' for percentage, or 0 if not specified.
kill_other_connections	a_bit_field	Set TRUE to drop connections with locks on tables being synchronized. Equivalent to the dbmlsync -d option.
last_upload_def	a_syncpub *	Reserved; use NULL.
lite_blob_handling	a_bit_field	Reserved; use 0.
log_file_name	const char *	Database server message log file name. Equivalent to dbmlsync -o or -ot option.
log_size	a_sql_uint32	Size in bytes of log file when renaming and restarting the transaction log. Specify 0 for unspecified size. Equivalent to the dbmlsync -x option.
logrtn	MSG_CALLBACK	Address of a logging callback routine to write messages only to a log file or NULL.
max_cache	a_sql_uint32	Maximum size for cache. Equivalent to the dbmlsync -cm option.
max_cache_suffix	char	Suffix for maximum cache size ('B' for bytes, 'P' for percentage, or 0 if not specified.
min_cache	a_sql_uint32	Minimum size for cache. Equivalent to the dbmlsync -cl option.
min_cache_suffix	char	Suffix for minimum cache size ('B' for bytes, 'P' for percentage, or 0 if not specified.
mlpassword	char *	The MobiLink password or NULL, if the option is not specified. Equivalent to the dbmlsync -mp option.
msgqueuertn	MSG_QUEUE_CALLBACK	Function called by DBMLSync when it wants to sleep. The parameter specifies the sleep period in milliseconds. The function should return the following, as defined in dllapi.h. MSGQ_SLEEP_THROUGH indicates that the routine slept for the requested number of milliseconds. This is usually the value you should return. MSGQ_SHUTDOWN_REQUESTED indicates that you would like the synchronization to terminate as soon as possible. MSGQ_SYNC_REQUESTED indicates that the routine slept for less than the requested number of milliseconds and that the next synchronization should begin immediately if a synchronization is not currently in progress.
msgrtn	MSG_CALLBACK	Address of an information message callback routine or NULL.
new_mlpassword	char *	The new MobiLink password or NULL, if the option is not specified. Equivalent to the dbmlsync -mn option.
no_offline_logscan	a_sql_uint32	Set TRUE to disable offline logscan (cannot use with -x). Equivalent to the dbmlsync -do option.
no_schema_cache	a_bit_field	Reserved; use 0.
no_stream_compress	a_bit_field	Reserved; use 0.
offline_dir	const char *	Transaction logs directory. Last item specified on dbmlsync command line.
output_to_file	a_bit_field	Reserved; use 0.
output_to_mobile_link	a_bit_field	Reserved; use 1.
persist_connection	a_bit_field	Set TRUE to persist the MobiLink connection between synchronizations. Set FALSE to close the MobiLink connection between synchronizations. Equivalent to the dbmlsync -pc{+\|-} option.
ping	a_bit_field	Set TRUE to ping MobiLink server. Equivalent to the dbmlsync -pi option.
preload_dlls	char *	Reserved; use NULL.
progress_index_rtn	SET_PROGRESS_CALLBACK	Function called to update the state of the progress bar.
progress_msg_rtn	MSG_CALLBACK	Function called to change the text in the status window, above the progress bar.
prompt_again	a_bit_field	Reserved; use 0.
prompt_for_encrypt_key	a_bit_field	Reserved; use 0.
raw_file	const char *	Reserved; use NULL.
rename_log	a_bit_field	Set TRUE to rename and restart the transaction log. See log_size field. Equivalent to the dbmlsync -x option.
retry_remote_ahead	a_bit_field	Set TRUE to resend upload using remote offset on progress mismatch when remote offset is greater than consolidated offset. Equivalent to the dbmlsync -ra option.
retry_remote_behind	a_bit_field	Set TRUE to resend upload using remote offset on progress mismatch. when remote offset is less than consolidated offset. Equivalent to the dbmlsync -r or -rb option.
script_full_path	char *	Deprecated; use NULL.
server_mode	a_bit_field	Set TRUE to run in server mode. Equivalent to the dbmlsync -sm option.
server_port	a_sql_uint32	Set communication port when running in server mode. Equivalent to the dbmlsync -po option.
set_window_title_rtn	SET_WINDOW_TITLE_CALLBACK	Function to call to change the title of the dbmlsync window (Windows only).
status_rtn	STATUS_CALLBACK	Reserved; use NULL.
strictly_ignore_trigger_ops	a_bit_field	Reserved; use 0.
sync_opt	char *	Reserved; use NULL.
sync_params	char *	User authentication parameters. Equivalent to the dbmlsync -ap option.
sync_profile	char *	Synchronization profile to execute. Equivalent to the dbmlsync -sp option.
trans_upload	a_bit_field	Set TRUE to upload each database transaction separately. Equivalent to the dbmlsync -tu option.
upld_fail_len	a_sql_uint32	Reserved; use 0.
upload_defs	a_syncpub *	Linked list of publications/subscriptions to synchronize.
upload_only	a_bit_field	Set TRUE to perform upload-only synchronization. Equivalent to the dbmlsync -uo option.
usage_rtn	USAGE_CALLBACK	Reserved; use NULL.
use_fixed_cache	a_bit_field	Reserved; use 0.
use_hex_offsets	a_bit_field	Reserved; use 0.
use_relative_offsets	a_bit_field	Reserved; use 0.
used_dialog_allocation	a_bit_field	Reserved; use 0.
user_name	char *	The MobiLink user to synchronize (deprecated). Equivalent to the dbmlsync -u option.
verbose	a_bit_field	Reserved; use 0.
verbose_download	a_bit_field	Reserved; use 0.
verbose_download_data	a_bit_field	Reserved; use 0.
verbose_hook	a_bit_field	Set TRUE to show hook script information. Equivalent to the dbmlsync -vs option.
verbose_minimum	a_bit_field	Set TRUE to set verbosity at a minimum. Equivalent to the dbmlsync -v option.
verbose_option_info	a_bit_field	Set TRUE to show command line and extended options. Equivalent to the dbmlsync -vo option.
verbose_protocol	a_bit_field	Reserved; use 0.
verbose_row_cnts	a_bit_field	Set TRUE to show upload/download row counts. Equivalent to the dbmlsync -vn option.
verbose_row_data	a_bit_field	Set TRUE to show upload/download row values. Equivalent to the dbmlsync -vr option.
verbose_server	a_bit_field	Reserved; use 0.
verbose_upload	a_bit_field	Set TRUE to show upload stream information. Equivalent to the dbmlsync -vu option.
verbose_upload_data	a_bit_field	Reserved; use 0.
version	unsigned short	DBTools version number (DB_TOOLS_VERSION_NUMBER).
warningrtn	MSG_CALLBACK	Function called to display warning messages.

Some members correspond to features accessible from the dbmlsync command line utility. Unused members should be assigned the value 0, FALSE, or NULL, depending on data type.

a_sync_db structure

Syntax

Members

Remarks

See also