IMAPIMessageSite::GetSiteStatus
Aplica-se a: Outlook 2013 | Outlook 2016
Retorna informações de um objeto do site de mensagens sobre os recursos do site de mensagens para a mensagem atual.
HRESULT GetSiteStatus(
ULONG FAR * lpulStatus
);
Parâmetros
lpulStatus
[out] Um ponteiro para um bitmask de sinalizadores que fornece informações sobre status de mensagem. Os seguintes sinalizadores podem ser definidos:
VCSTATUS_COPY
A mensagem pode ser copiada.
VCSTATUS_DELETE
A mensagem pode ser excluída.
VCSTATUS_DELETE_IS_MOVE
Quando excluída, uma mensagem é movida para uma pasta Itens Excluídos em seu repositório de mensagens, em vez de ser imediatamente removida de seu repositório de mensagens.
VCSTATUS_MOVE
A mensagem pode ser movida.
VCSTATUS_NEW_MESSAGE
Uma nova mensagem pode ser criada.
VCSTATUS_SAVE
A mensagem pode ser salva.
VCSTATUS_SUBMIT
A mensagem pode ser enviada.
Valor de retorno
S_OK
A chamada foi bem-sucedida e retornou o valor ou valores esperados.
Comentários
Os objetos de formulário chamam o método IMAPIMessageSite::GetSiteStatus para obter os recursos do objeto do site de mensagens para a mensagem atual. Os sinalizadores retornados no parâmetro lpulStatus fornecem informações sobre o site de mensagens. Normalmente, um formulário habilita ou desabilita comandos de menu, dependendo das informações que os sinalizadores fornecem sobre os recursos da implementação do site de mensagens. Se uma nova mensagem for carregada em um formulário pelo método IPersistMessage::SaveCompleted ou pelo método IPersistMessage::Load, os sinalizadores de status deverão ser verificados. Alguns objetos do site de mensagens, especialmente objetos somente leitura, não permitem que mensagens sejam salvas ou excluídas.
Observações para implementadores
O método IMAPIMessageSite::GetSiteStatus pode exigir que o aplicativo cliente faça algum cálculo para determinar quais operações podem ou não ser executadas na mensagem atual. Normalmente, isso envolve examinar a linha status para o provedor de armazenamento de mensagens da mensagem atual ou consultar o provedor da loja para determinar quais ações o aplicativo cliente pode executar usando o repositório de mensagens. Por exemplo, para determinar se deve retornar o sinalizador MAPI_DELETE_IS_MOVE, marcar a propriedade PR_IPM_WASTEBASKET_ENTRYID do objeto do repositório de mensagens (PidTagIpmWastebasketEntryId) para ver se há uma pasta Itens Excluídos no repositório de mensagens.
Para obter uma lista de interfaces relacionadas a servidores de formulário, consulte Interfaces de Formulário MAPI.
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MyMAPIFormViewer.cpp |
CMyMAPIFormViewer::GetSiteStatus |
O MFCMAPI usa o método IMAPIMessageSite::GetSiteStatus para obter o status do site especificado. Ele pode retornar VCSTATUS_NEW_MESSAGE, VCSTATUS_SAVE ou VCSTATUS_SUBMIT. |
Confira também
IPersistMessage::SaveCompleted
Propriedade Canônica PidTagIpmWastebasketEntryId