IMAPISupport::Subscribe
Aplica-se a: Outlook 2013 | Outlook 2016
Registra um coletor de aconselhamento para receber notificações por meio do MAPI.
HRESULT Subscribe(
LPNOTIFKEY lpKey,
ULONG ulEventMask,
ULONG ulFlags,
LPMAPIADVISESINK lpAdviseSink,
ULONG FAR * lpulConnection
);
Parâmetros
lpKey
[in] Um ponteiro para uma chave de notificação que representa o objeto de origem de aconselhamento. O parâmetro lpKey não pode ser NULL.
ulEventMask
[in] Uma máscara de valores que indica os tipos de eventos de notificação nos quais o chamador está interessado e deve ser incluída no registro. Os seguintes valores são válidos:
fnevCriticalError
Registra notificações sobre erros graves, como memória insuficiente.
fnevExtended
Registra notificações sobre eventos específicos para o catálogo de endereços ou provedor de armazenamento de mensagens específico.
fnevNewMail
Registra-se para notificações sobre a chegada de novas mensagens.
fnevObjectCreated
Registra notificações sobre a criação de um novo objeto.
fnevObjectCopied
Registra notificações sobre um objeto que está sendo copiado.
fnevObjectDeleted
Registra notificações sobre um objeto que está sendo excluído.
fnevObjectModified
Registra notificações sobre um objeto que está sendo modificado.
fnevObjectMoved
Registra notificações sobre um objeto que está sendo movido.
fnevSearchComplete
Registra notificações sobre a conclusão de uma operação de pesquisa.
ulFlags
[in] Um bitmask de sinalizadores que controla como a notificação ocorre. O seguinte sinalizador pode ser definido:
NOTIFY_SYNC
Quando o chamador chama o método IMAPISupport::Notify para gerar notificações para este coletor de aconselhamento, Notificar deve fazer todas as chamadas necessárias para aconselhar coletores antes de retornar. Se esse sinalizador não estiver definido, a notificação será assíncrona e os retornos de chamada serão enfileirados nos processos inscritos e iniciados quando esses processos ganham o controle da CPU.
lpAdviseSink
[in] Um ponteiro para um objeto de coletor de aconselhamento.
lpulConnection
[out] Um ponteiro para um número de conexão não zero que representa o registro.
Valor de retorno
S_OK
O registro de notificação foi bem-sucedido.
Comentários
O método IMAPISupport::Subscribe é implementado para todos os objetos de suporte do provedor de serviços. Os provedores de serviços chamam Assinar de um de seus métodos de aconselhamento para permitir que o MAPI gerencie as notificações.
Notas para chamadores
Para usar os métodos de suporte mapi para notificação, crie uma chave para a fonte de aconselhamento do objeto sobre quais notificações devem ser geradas. O valor da chave deve ser exclusivo e deve ser facilmente regenerado sempre que o objeto for alterado.
O MAPI usa a chave de notificação para pesquisar quaisquer funções de retorno de chamada registradas por meio da função HrAllocAdviseSink para a fonte de aconselhamento correspondente. Passe essa chave para IMAPISupport::Notificar sempre que precisar gerar uma notificação para a fonte de aconselhamento correspondente.
O sinalizador NOTIFY_SYNC afeta a operação de chamadas subsequentes para Notificar. Quando você define NOTIFY_SYNC, Notificar não retorna até que ele termine de enviar todas as notificações necessárias. Quando você não define NOTIFY_SYNC, o Notify opera de forma assíncrona, possivelmente retornando antes de todas as notificações serem enviadas.