Notificações (API de Instalação)
As notificações são valores que uma função de instalação envia a uma rotina de retorno de chamada para especificar um estado ou evento. Dois parâmetros, Param1 e Param2, são enviados com a notificação e contêm informações adicionais relevantes para a notificação.
A rotina de retorno de chamada processa a notificação e retorna um inteiro sem sinal para a função de instalação. Dependendo da função de instalação, você pode usar esse valor para especificar uma operação ou seleção de usuário ou pode ignorá-la.
As funções de instalação enviam notificações para rotinas de retorno de chamada usando a sintaxe a seguir.
MsgHandler( //the specified callback routine
Context, //context used by the callback routine
Notification, //notification code
Param1, //additional notification information
Param2 //additional notification information
);
O parâmetro Context é um ponteiro nulo para uma variável de contexto ou estrutura que a rotina de retorno de chamada pode usar para armazenar informações que devem persistir entre chamadas subsequentes à rotina de retorno de chamada.
Como a rotina de retorno de chamada especifica a implementação do contexto e nunca é referenciada ou alterada pelas funções de instalação, o contexto não está documentado no material de referência para as mensagens de notificação a seguir.
O parâmetro Notification especifica um valor inteiro sem sinal para um evento ou estado que faz com que a função de instalação chame a rotina de retorno de chamada.
param1 e param2 são parâmetros opcionais que podem conter informações adicionais relevantes para a notificação. Esses parâmetros são inteiros sem sinal. Se Param1 ou Param2 retornar informações que não são um inteiro sem sinal, ela será convertida em um inteiro sem sinal e deverá ser reformulada para seu tipo de dados original antes que possa ser usada pela rotina de retorno de chamada.
Nota
As notificações a seguir representam cada notificação usada pelas funções de instalação. As funções individuais usam um subconjunto dessas notificações. Em outras palavras, nem todas as notificações são usadas por todas as funções.
As notificações a seguir são usadas pelas funções de instalação.
Notificação | Descrição |
---|---|
SPFILENOTIFY_COPYERROR | Ocorreu um erro durante uma operação de cópia de arquivo. |
SPFILENOTIFY_DELETEERROR | Ocorreu um erro durante uma operação de exclusão de arquivo. |
SPFILENOTIFY_ENDCOPY | Uma operação de cópia de arquivo foi encerrada. |
SPFILENOTIFY_ENDDELETE | Uma operação de exclusão de arquivo foi encerrada. |
SPFILENOTIFY_ENDQUEUE | A fila terminou de se comprometer. |
SPFILENOTIFY_ENDREGISTRATION | O registro ou cancelamento do registro do arquivo foi concluído. |
SPFILENOTIFY_ENDRENAME | Uma operação de renomeação de arquivo foi encerrada. |
SPFILENOTIFY_ENDSUBQUEUE | Uma subconsulta (copiar, renomear ou excluir) terminou. |
SPFILENOTIFY_FILEEXTRACTED | O arquivo foi extraído do gabinete. |
SPFILENOTIFY_FILEINCABINET | Um arquivo é encontrado no gabinete. |
SPFILENOTIFY_FILEOPDELAYED | O arquivo estava em uso e a operação atual foi atrasada até que o sistema seja reinicializado. |
SPFILENOTIFY_LANGMISMATCH | O idioma da operação atual não corresponde ao idioma do sistema. |
SPFILENOTIFY_NEEDMEDIA | A nova mídia de origem é necessária. |
SPFILENOTIFY_NEEDNEWCABINET | O arquivo atual continua no próximo gabinete. |
SPFILENOTIFY_QUEUESCAN | Um nó na fila de arquivos foi verificado. |
SPFILENOTIFY_QUEUESCAN_EX | Um nó na fila de arquivos foi verificado. |
SPFILENOTIFY_QUEUESCAN_SIGNERINFO | Um nó na fila de arquivos foi verificado. |
SPFILENOTIFY_RENAMEERROR | Ocorreu um erro durante uma operação de renomeação de arquivo. |
SPFILENOTIFY_STARTCOPY | Uma operação de cópia de arquivo foi iniciada. |
SPFILENOTIFY_STARTDELETE | Uma operação de exclusão de arquivo foi iniciada. |
SPFILENOTIFY_STARTQUEUE | A fila começou a ser confirmada. |
SPFILENOTIFY_STARTREGISTRATION | O registro ou cancelamento do registro do arquivo foi iniciado. |
SPFILENOTIFY_STARTRENAME | Uma operação de renomeação de arquivo foi iniciada. |
SPFILENOTIFY_STARTSUBQUEUE | Uma subconsulta (copiar, renomear ou excluir) foi iniciada. |
SPFILENOTIFY_TARGETEXISTS | Uma cópia do arquivo especificado já existe no destino. |
SPFILENOTIFY_TARGETNEWER | Existe uma versão mais recente do arquivo especificado no destino. |