IMAPISession::PrepareForm

Applies to: Outlook 2013 | Outlook 2016

Creates a numeric token that the IMAPISession::ShowForm method uses to access a message.

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

Parameters

lpInterface

[in] A pointer to the interface identifier (IID) that represents the interface to be used to access the message. Passing null results in the standard interface, or IMessage, being used. The lpInterface parameter must be null or IID_IMessage.

lpMessage

[in] A pointer to the message to be displayed in the form.

lpulMessageToken

[out] A pointer to a message token, which is used by the IMAPISession::ShowForm method to access the message pointed to by lpMessage.

Return value

S_OK

The form preparation was successful.

Remarks

The IMAPISession::PrepareForm method creates a message token for the message pointed to by the lpMessage parameter and calls the message's IUnknown::AddRef method. This token is passed in the ulMessageToken parameter to IMAPISession::ShowForm.

Notes to callers

If the call to PrepareForm succeeds, release the message pointed to by lpMessage by calling its IUnknown::Release method before you call ShowForm. Failure to release the message before you call ShowForm can cause memory leaks.

MFCMAPI reference

For MFCMAPI sample code, see the following table.

See also

IMAPISession::ShowForm

IMAPISession : IUnknown

MFCMAPI as a Code Sample