Compartilhar via


IMAPISession::PrepareForm

Aplica-se a: Outlook 2013 | Outlook 2016

Cria um token numérico que o método IMAPISession::ShowForm usa para acessar uma mensagem.

HRESULT PrepareForm(
  LPCIID lpInterface,
  LPMESSAGE lpMessage,
  ULONG FAR * lpulMessageToken
);

Parâmetros

lpInterface

[in] Um ponteiro para o IID (identificador de interface) que representa a interface a ser usada para acessar a mensagem. Passar resultados nulos na interface padrão, ou IMessage, que está sendo usada. O parâmetro lpInterface deve ser nulo ou IID_IMessage.

Lpmessage

[in] Um ponteiro para a mensagem a ser exibida no formulário.

lpulMessageToken

[out] Um ponteiro para um token de mensagem, que é usado pelo método IMAPISession::ShowForm para acessar a mensagem apontada por lpMessage.

Valor de retorno

S_OK

A preparação do formulário foi bem-sucedida.

Comentários

O método IMAPISession::P repareForm cria um token de mensagem para a mensagem apontada pelo parâmetro lpMessage e chama o método IUnknown::AddRef da mensagem. Esse token é passado no parâmetro ulMessageToken para IMAPISession::ShowForm.

Notas para chamadores

Se a chamada para PrepareForm for bem-sucedida, libere a mensagem apontada por lpMessage chamando seu método IUnknown::Release antes de chamar ShowForm. A falha ao liberar a mensagem antes de chamar ShowForm pode causar vazamentos de memória.

Referência do MFCMAPI

Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.

Arquivo Função Comentário
MAPIFormFunctions.cpp
OpenMessageModal
O MFCMAPI usa o método IMAPISession::P repareForm , juntamente com IMAPISession::ShowForm, para exibir uma mensagem em um formulário modal.

Confira também

IMAPISession::ShowForm

IMAPISession : IUnknown

MFCMAPI como exemplo de código