Compartilhar via


IMAPIMessageSite::GetMessage

Aplica-se a: Outlook 2013 | Outlook 2016

Retorna a mensagem atual.

HRESULT GetMessage(
  LPMESSAGE FAR * ppmsg
);

Parâmetros

ppmsg

[out] Um ponteiro para um ponteiro para a interface retornada para a mensagem.

Valor de retorno

S_OK

A chamada foi bem-sucedida e retornou o valor ou valores esperados.

S_FALSE

No momento, nenhuma mensagem existe para o formulário de chamada.

Comentários

Os formulários chamam o método IMAPIMessageSite::GetMessage para obter uma interface de mensagem para a mensagem atual. A mensagem atual é a mesma que foi passada anteriormente no método IPersistMessage::InitNew, IPersistMessage::Load ou IPersistMessage::SaveCompleted .

GetMessage retornará S_FALSE se nenhuma mensagem existir no momento. Esse estado pode ocorrer após chamadas para o método IPersistMessage::HandsOffMessage ou antes da próxima chamada para IPersistMessage::Load ou IPersistMessage::SaveCompleted é feita.

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::GetSession
O MFCMAPI usa o método IMAPIMessageSite::GetMessage para retornar o ponteiro de mensagem armazenado em cache no momento, se estiver disponível.

Confira também

IPersistMessage::HandsOffMessage

IPersistMessage::InitNew

IPersistMessage : IUnknown

IPersistMessage::Load

IPersistMessage::SaveCompleted

IMAPIMessageSite : IUnknown

MFCMAPI como exemplo de código

Interfaces de Formulário MAPI