Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SQL Anywhere 11.0.0 » MobiLink - Client Administration » Introduction to SQL Anywhere Clients for MobiLink » Event hooks for SQL Anywhere clients



Use this stored procedure to manage exit codes.

Rows in #hook_dict table




publication_n (in)


The publications being synchronized, where n is an integer. There is one publication_n entry for each publication being uploaded. The numbering of n starts at zero.

MobiLink user (in)

MobiLink user name

The MobiLink user for which you are synchronizing.

fatal error (in)

true | false

True when the hook is called because of an error that causes dbmlsync to terminate.

aborted synchronization (in)

true | false

True when the hook is called because of an abort request from the sp_hook_dbmlsync_abort hook.

exit code (in)


The exit code from the most recent synchronization attempt. 0 indicates a successful synchronization. Any other value indicates that the synchronization failed. This value can be set by sp_hook_dbmlsync_abort when that hook is used to abort synchronization.

last exit code (in)


The value stored in the new exit code row of the #hook_dict table the last time this hook was called, or 0 if this is the first call to the hook.

new exit code (in|out)


The exit code you choose for the process. When dbmlsync exits, its exit code is the value stored in this row by the last call to the hook. The value must be -32768 to 32767.

script version (in)

script version name

The MobiLink script version to be used for the synchronization.


A dbmlsync session can run multiple synchronizations when you specify the -n option more than once in the command line, when you use scheduling, or when you use the restart parameter in sp_hook_dbmlsync_end. In these cases, if one or more of the synchronizations fail, the default exit code does not indicate which failed. Use this hook to define the exit code for the dbmlsync process based on the exit codes from the synchronizations. This hook can also be used to log exit codes.

If an error occurs during startup before a synchronization has been initiated, the #hook_dict entries for MobiLink user and Script version are set to an empty string, and no publication_n rows are set in the #hook_dict table.


Suppose that you run dbmlsync to perform five synchronizations and you want the exit code to indicate how many of the synchronizations failed, with an exit code of 0 indicating that there were no failures, an exit code of 1 indicating that one synchronization failed, and so on. You can achieve this by defining the sp_hook_dbmlsync_process_exit_code hook as follows. In this case, if three synchronizations fail, the new exit code is 3.

CREATE PROCEDURE sp_hook_dbmlsync_process_exit_code()

   SELECT value INTO rc FROM #hook_dict WHERE name = 'exit code';
   IF rc <> 0 THEN
      SELECT value INTO rc FROM #hook_dict WHERE name = 'last exit code';
      UPDATE #hook_dict SET value = rc + 1 WHERE name = 'new exit code';   
   END IF;
See also