Skip to main content
Version: 20 R7 BETA

On Backup Shutdown database method

$1 -> On Backup Shutdown database method

ParameterTypeDescription
$1Integer←0 = backup executed correctly; other value = error, interrupted by user or code returned by On Backup Startup

This command is not thread-safe, it cannot be used in preemptive code.

The On Backup Shutdown database method is called every time a database backup ends. The reasons for the stoppage of a backup can be the end of the copy, user interruption or an error.
This concerns all 4D environments: 4D (all modes), 4D Server as well as 4D applications compiled and merged with 4D Volume Desktop.

The On Backup Shutdown database method allows verifying that the backup was executed correctly. It receives, in the $1 parameter, a value representing the status of the backup once completed:

  • If the backup was executed correctly, $1 equals 0.
  • If the backup was interrupted by the user or following an error, $1 is different from 0.
    • If the backup was stopped by the On Backup Startup Database Method ($0 # 0), $1 gets the value actually returned in the $0 parameter. This allows you to implement a customized error management system.
    • If the backup was stopped due to an error, the error code is returned in $1.
      In any case, you can get information about the error using the BACKUP INFO command.

Note: You must declare the $1 parameter (longint) in the database method:

 var $1 : Integer

It is important to note that in the case of an error during backup (disk full, support unavailable, etc.), the information related to the error is only displayed in the 4D Server monitor or in the MSC, and copied into the backup log. No alert dialog box appears and the error variable is not modified. If you want to be able to notify the administrator that an error has occurred, particularly in the context of an application running in client/server mode, you will need to use the On Backup Shutdown database method.