Notificações (API de configuração)

Notificações são valores que uma função de instalação envia para 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 não assinado para a função de configuração. Dependendo da função de configuração, você pode usar esse valor para especificar uma operação ou seleção de usuário, ou você pode ignorá-lo.

As funções de configuraçã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 vazio para uma variável ou estrutura de contexto que a rotina de retorno de chamada pode usar para armazenar informações que devem persistir entre chamadas subsequentes para a 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 é documentado no material de referência para as mensagens de notificação a seguir.

O parâmetro Notification especifica um valor inteiro não assinado 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 não assinados. Se Param1 ou Param2 retornar informações que não sejam um número inteiro não assinado, elas serão convertidas em um inteiro não assinado e deverão ser reformuladas para seu tipo de dados original antes de poderem ser usadas pela rotina de retorno de chamada.

Observação

As notificações a seguir representam todas as notificações usadas pelas funções de configuração. 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 configuração.

Notificação	Descrição
SPFILENOTIFY_COPYERROR	Ocorreu um erro durante uma operação de cópia de ficheiro.
SPFILENOTIFY_DELETEERROR	Ocorreu um erro durante uma operação de eliminação de ficheiros.
SPFILENOTIFY_ENDCOPY	Uma operação de cópia de arquivo terminou.
SPFILENOTIFY_ENDDELETE	Uma operação de exclusão de arquivo terminou.
SPFILENOTIFY_ENDQUEUE	A fila terminou de confirmar.
SPFILENOTIFY_ENDREGISTRATION	O registo ou cancelamento do registo do ficheiro terminou.
SPFILENOTIFY_ENDRENAME	Uma operação de renomeação de arquivo terminou.
SPFILENOTIFY_ENDSUBQUEUE	Uma subfila (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 adiada até que o sistema seja reinicializado.
SPFILENOTIFY_LANGMISMATCH	O idioma da operação atual não corresponde ao idioma do sistema.
SPFILENOTIFY_NEEDMEDIA	É necessária uma nova mídia de origem.
SPFILENOTIFY_NEEDNEWCABINET	O arquivo atual é continuado 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	Foi iniciada uma operação de cópia de ficheiros.
SPFILENOTIFY_STARTDELETE	Foi iniciada uma operação de eliminação de ficheiros.
SPFILENOTIFY_STARTQUEUE	A fila começou a se confirmar.
SPFILENOTIFY_STARTREGISTRATION	O registo ou cancelamento do registo do ficheiro foi iniciado.
SPFILENOTIFY_STARTRENAME	Uma operação de renomeação de arquivo foi iniciada.
SPFILENOTIFY_STARTSUBQUEUE	Uma subfila (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.