Partager via

Notifications (API d’installation)

  • Article

Les notifications sont des valeurs qu’une fonction d’installation envoie à une routine de rappel pour spécifier un état ou un événement. Deux paramètres, Param1 et Param2, sont envoyés avec la notification et contiennent des informations supplémentaires relatives à la notification.

La routine de rappel traite la notification et retourne un entier non signé à la fonction d’installation. Selon la fonction d’installation, vous pouvez utiliser cette valeur pour spécifier une opération ou une sélection d’utilisateur, ou vous pouvez l’ignorer.

Les fonctions d’installation envoient des notifications aux routines de rappel à l’aide de la syntaxe suivante.

MsgHandler(          //the specified callback routine
    Context,         //context used by the callback routine
    Notification,    //notification code
    Param1,          //additional notification information
    Param2           //additional notification information
);

Le paramètre Context est un pointeur void vers une variable ou une structure de contexte que la routine de rappel peut utiliser pour stocker des informations qui doivent être conservées entre les appels suivants à la routine de rappel.

Étant donné que la routine de rappel spécifie l’implémentation du contexte et qu’elle n’est jamais référencée ou modifiée par les fonctions d’installation, le contexte n’est pas documenté dans le matériel de référence pour les messages de notification qui suivent.

Le paramètre Notification spécifie une valeur entière non signée pour un événement ou un état qui amène la fonction d’installation à appeler la routine de rappel.

Param1 et Param2 sont des paramètres facultatifs qui peuvent contenir des informations supplémentaires relatives à la notification. Ces paramètres sont des entiers non signés. Si Param1 ou Param2 renvoie des informations qui ne sont pas un entier non signé, elles sont converties en entier non signé et doivent être recastées dans leur type de données d’origine avant de pouvoir être utilisées par la routine de rappel.

Notes

Les notifications suivantes représentent chaque notification utilisée par les fonctions d’installation. Les fonctions individuelles utilisent un sous-ensemble de ces notifications. En d’autres termes, toutes les notifications ne sont pas utilisées par toutes les fonctions.

 

Les notifications suivantes sont utilisées par les fonctions d’installation.

Notification Description
SPFILENOTIFY_COPYERROR Une erreur s’est produite lors d’une opération de copie de fichiers.
SPFILENOTIFY_DELETEERROR Une erreur s’est produite lors d’une opération de suppression de fichier.
SPFILENOTIFY_ENDCOPY Une opération de copie de fichiers s’est terminée.
SPFILENOTIFY_ENDDELETE Une opération de suppression de fichier s’est terminée.
SPFILENOTIFY_ENDQUEUE La validation de la file d’attente est terminée.
SPFILENOTIFY_ENDREGISTRATION L’inscription ou la désinscription du fichier est terminée.
SPFILENOTIFY_ENDRENAME Une opération de renommage de fichier s’est terminée.
SPFILENOTIFY_ENDSUBQUEUE Une sous-file d’attente (copier, renommer ou supprimer) a pris fin.
SPFILENOTIFY_FILEEXTRACTED Le fichier a été extrait de l’armoire.
SPFILENOTIFY_FILEINCABINET Un fichier est rencontré dans l’armoire.
SPFILENOTIFY_FILEOPDELAYED Le fichier était en cours d’utilisation et l’opération en cours a été retardée jusqu’à ce que le système soit redémarré.
SPFILENOTIFY_LANGMISMATCH La langue de l’opération actuelle ne correspond pas à la langue système.
SPFILENOTIFY_NEEDMEDIA Un nouveau média source est requis.
SPFILENOTIFY_NEEDNEWCABINET Le dossier actuel est poursuivi dans le cabinet suivant.
SPFILENOTIFY_QUEUESCAN Un nœud de la file d’attente de fichiers a été analysé.
SPFILENOTIFY_QUEUESCAN_EX Un nœud de la file d’attente de fichiers a été analysé.
SPFILENOTIFY_QUEUESCAN_SIGNERINFO Un nœud de la file d’attente de fichiers a été analysé.
SPFILENOTIFY_RENAMEERROR Une erreur s’est produite lors d’une opération de renommage de fichier.
SPFILENOTIFY_STARTCOPY Une opération de copie de fichiers a démarré.
SPFILENOTIFY_STARTDELETE Une opération de suppression de fichier a démarré.
SPFILENOTIFY_STARTQUEUE La validation de la file d’attente a commencé.
SPFILENOTIFY_STARTREGISTRATION L’inscription ou la désinscription du fichier a démarré.
SPFILENOTIFY_STARTRENAME Une opération de renommage de fichier a démarré.
SPFILENOTIFY_STARTSUBQUEUE Une sous-file d’attente (copier, renommer ou supprimer) a démarré.
SPFILENOTIFY_TARGETEXISTS Une copie du fichier spécifié existe déjà sur la cible.
SPFILENOTIFY_TARGETNEWER Une version plus récente du fichier spécifié existe sur la cible.