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 pertinentes pour 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 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 de contexte ou une structure que la routine de rappel peut utiliser pour stocker les informations qui doivent persister 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 entraîne l’appel de la routine de rappel par la fonction d’installation.

Param1 et Param2 sont des paramètres facultatifs qui peuvent contenir des informations supplémentaires pertinentes pour la notification. Ces paramètres sont des entiers non signés. Si Param1 ou Param2 renvoyer des informations qui ne sont pas un entier non signé, il est converti en entier non signé et doit être recastré en son type de données d’origine avant de pouvoir être utilisé par la routine de rappel.

Note

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 chaque fonction.

 

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 fichier.
SPFILENOTIFY_DELETEERROR Une erreur s’est produite lors d’une opération de suppression de fichier.
SPFILENOTIFY_ENDCOPY Une opération de copie de fichier s’est terminée.
SPFILENOTIFY_ENDDELETE Une opération de suppression de fichier s’est terminée.
SPFILENOTIFY_ENDQUEUE La file d’attente a terminé la validation.
SPFILENOTIFY_ENDREGISTRATION L’inscription ou l’annulation de l’inscription du fichier a terminé.
SPFILENOTIFY_ENDRENAME Une opération de renommage de fichier s’est terminée.
SPFILENOTIFY_ENDSUBQUEUE Un sous-file d’attente (copie, renommage ou suppression) s’est terminé.
SPFILENOTIFY_FILEEXTRACTED Le fichier a été extrait du cabinet.
SPFILENOTIFY_FILEINCABINET Un fichier est rencontré dans le cabinet.
SPFILENOTIFY_FILEOPDELAYED Le fichier était en cours d’utilisation et l’opération actuelle 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 se poursuit dans le cabinet suivant.
SPFILENOTIFY_QUEUESCAN Un nœud dans la file d’attente de fichiers a été analysé.
SPFILENOTIFY_QUEUESCAN_EX Un nœud dans la file d’attente de fichiers a été analysé.
SPFILENOTIFY_QUEUESCAN_SIGNERINFO Un nœud dans 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 fichier a démarré.
SPFILENOTIFY_STARTDELETE Une opération de suppression de fichier a démarré.
SPFILENOTIFY_STARTQUEUE La file d’attente a commencé à valider.
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 Un 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.