On Backup Shutdown database method
$1 -> On Backup Shutdown database method
| Paramètre | Type | Description | |
|---|---|---|---|
| $1 | Entier long | ← | 0 = sauvegarde terminée normalement, autre valeur = erreur, interruption utilisateur ou code retourné par Sur démarrage sauvegarde |
Cette commande n'est pas thread-safe, elle ne peut pas être utilisée dans du code préemptif.
La On Backup Shutdown database method est appelée à chaque fois qu’une sauvegarde de la base vient de se terminer. Les causes de l’arrêt de la sauvegarde peuvent être la fin de la copie, l’interruption par l’utilisateur ou une erreur.
Tous les environnements 4D sont concernés : 4D (tous modes), 4D Server ainsi que les applications 4D compilées et fusionnées avec 4D Volume Desktop.
La On Backup Shutdown database method permet de vérifier que la sauvegarde s’est correctement déroulée. Elle reçoit dans le paramètre $1 une valeur indiquant le statut de la sauvegarde à l’issue de son exécution :
- Si la sauvegarde s’est terminée normalement, $1 vaut 0.
- Si la sauvegarde a été interrompue à la suite d'une erreur ou par l'utilisateur, $1 est différent de 0.
- Si la sauvegarde a été stoppée par la Méthode base Sur démarrage sauvegarde ($0 # 0), $1 retourne le code effectivement retourné dans le paramètre $0. Ce principe vous permet de mettre en place un système de gestion d’erreurs personnalisé.
- Si la sauvegarde a été stoppée à la suite d'une erreur, le code de l'erreur est retourné dans $1.
Dans tous les cas, vous pouvez obtenir des informations sur l'erreur à l’aide de la commande BACKUP INFO.
Note : Vous devez impérativement déclarer le paramètre $1 (entier long) dans la méthode base :
var $1 : Integer
Il est important de noter qu'en cas d'erreur durant la sauvegarde (disque plein, support inaccessible...), les informations relatives à l'erreur sont uniquement affichées dans le moniteur de 4D Server ou dans le CSM, et reportées dans le journal des sauvegardes. Aucune boîte de dialogue d'alerte n'est affichée et la variable error n'est pas modifiée. Si vous souhaitez pouvoir notifier l'administrateur qu'une erreur s'est produite, en particulier dans le contexte d'une application en mode client/serveur, il est nécessaire d'utiliser la On Backup Shutdown database method.