Declare and initialize the a_dbtools_info structure.

a_dbtools_info   info;
short ret;
...
// clear a_dbtools_info fields
memset( &info, 0, sizeof( info ) ); 
info.errorrtn = dbsyncErrorCallBack;

The dbsyncErrorCallBack function handles error messages and is defined in step 4 of this procedure.

Use the DBToolsInit function to initialize DBTools.

ret = DBToolsInit( &info );
if( ret != 0 ) {
 printf("dbtools initialization failure \n");
}

For more information about DBTools initialization, see:

• Using the database tools interface
• a_dbtools_info structure
• DBToolsInit function

Declare an a_sync_db instance. For example, declare an instance called dbsync_info:

a_sync_db dbsync_info;

Clear a_sync_db structure fields.

memset( &dbsync_info, 0, sizeof( dbsync_info ) );

Set required a_sync_db fields.

dbsync_info.version = DB_TOOLS_VERSION_NUMBER;
dbsync_info.output_to_mobile_link = 1;
dbsync_info.default_window_title 
  = "dbmlsync dbtools sample";

Set the database connection string.

dbsync_info.connectparms = "uid=DBA;pwd=sql";

For more information about database connection parameters, see -c dbmlsync option.

Set other a_sync_db fields to customize synchronization.

Most fields correspond to dbmlsync command line options. For more information about this correspondence, see dbtools.h.

In the example below, verbose operation is enabled.

dbsync_info.verbose_upload = 1;
dbsync_info.verbose_option_info = 1;
dbsync_info.verbose_row_data = 1;
dbsync_info.verbose_row_cnts = 1;

For example, create a function called dbsyncErrorCallBack to handle generated error messages:

extern short _callback dbsyncErrorCallBack( char *str )
{
    if( str != NULL ) {
        printf( "Error Msg    %s\n", str );
    }
    return 0;
}

For example, create a function called dbsyncWarningCallBack to handle generated warning messages:

extern short _callback dbsyncWarningCallBack( char *str )
{
    if( str != NULL ) {
        printf( "Warning Msg  %s\n", str );
    }
    return 0;
}

For example, create a function called dbsyncLogCallBack to receive verbose informational messages that you might choose to log to a file instead of displaying in a window:

extern short _callback dbsyncLogCallBack( char *str )
{
    if( str != NULL ) {
        printf( "Log Msg      %s\n", str );
    }
    return 0;
}

For example, create a function called dbsyncMsgCallBack to receive informational messages generated during synchronization.

extern short _callback dbsyncMsgCallBack( char *str )
{
    if( str != NULL ) {
        printf( "Display Msg  %s\n", str );
    }
    return 0;
}

For example, create a function called dbsyncProgressMessageCallBack to receive the progress text. In the dbmlsync utility, this text is displayed directly above the progress bar.

extern short _callback dbsyncProgressMessageCallBack(
 char *str )
{
    if( str != NULL ) {
        printf( "ProgressText %s\n", str );
    }
    return 0;
}

For example, create a function called dbsyncProgressIndexCallBack to receive information for updating a progress indicator or progress bar. This function receives two parameters:

extern short _callback dbsyncProgressIndexCallBack
(a_sql_uint32 index, a_sql_uint32 max )
{
    printf( "ProgressIndex    Index %d Max: %d\n",
         index, max );
    return 0;
}

A typical sequence of calls to this callback is shown below

// example calling sequence
dbsyncProgressIndexCallBack( 0, 100 );
dbsyncProgressIndexCallBack( 25, 0 );
dbsyncProgressIndexCallBack( 50, 0 );
dbsyncProgressIndexCallBack( 75, 0 );
dbsyncProgressIndexCallBack( 100, 0 );

This sequence should result in the progress bar being set to 0% done, 25% done, 50% done, 75% done, and 100% done.

For example, create a function called dbsyncWindowTitleCallBack to receive status information. In the dbmlsync utility, this information is displayed in the title bar.

extern short _callback dbsyncWindowTitleCallBack(
 char *title )
{
    printf( "Window Title     %s\n", title );
    return 0;
}

The dbsyncMsgQueueCallBack function is called when a delay or sleep is required. It must return one of the following values, which are defined in dllapi.h.

extern short _callback dbsyncMsgQueueCallBack(
   a_sql_uint32 sleep_period_in_milliseconds )
{

 printf( "Sleep %d ms\n", sleep_period_in_milliseconds );
 Sleep( sleep_period_in_milliseconds );
 return MSGQ_SLEEP_THROUGH; 
}

Assign callback function pointers to the appropriate a_sync_db synchronization structure fields.

// set call back functions
dbsync_info.errorrtn    = dbsyncErrorCallBack;
dbsync_info.warningrtn  = dbsyncWarningCallBack;
dbsync_info.logrtn      = dbsyncLogCallBack;
dbsync_info.msgrtn      = dbsyncMsgCallBack;
dbsync_info.msgqueuertn = dbsyncMsgQueueCallBack;
dbsync_info.progress_index_rtn
     = dbsyncProgressIndexCallBack;
dbsync_info.progress_msg_rtn
     = dbsyncProgressMessageCallBack;
dbsync_info.set_window_title_rtn
     = dbsyncWindowTitleCallBack;

Declare an a_syncpub instance. For example, call it publication_info:

a_syncpub publication_info;

Initialize a_syncpub fields, specifying subscriptions you want to synchronize.

For example, to synchronize the template_p1 and template_p2 subscriptions together in a single synchronization session:

publication_info.next = NULL; // linked list terminates
publication_info.subscription = "template_p1,template_p2";
publication_info.ext_opt  = "dir=c:\\logs";
publication_info.alloced_by_dbsync = 0;
publication_info.pub_name = NULL;

This is equivalent to specifying -s template_p1,template_p2 on the dbmlsync command line.

Specifying extended options using the ext_opt field, provides the same functionality as the dbmlsync -eu option.

See -eu dbmlsync option.

Assign the publication structure to the upload_defs field of your a_sync_db instance.

dbsync_info.upload_defs   = &publication_info;