IMAPISession::PrepareForm
Область применения: Outlook 2013 | Outlook 2016
Создает числовой маркер, который метод IMAPISession::ShowForm использует для доступа к сообщению.
HRESULT PrepareForm(
LPCIID lpInterface,
LPMESSAGE lpMessage,
ULONG FAR * lpulMessageToken
);
Параметры
lpInterface
[в] Указатель на идентификатор интерфейса (IID), представляющий интерфейс, используемый для доступа к сообщению. Передача null приводит к использованию стандартного интерфейса или IMessage. Параметр lpInterface должен иметь значение NULL или IID_IMessage.
lpMessage
[в] Указатель на сообщение, отображаемое в форме.
lpulMessageToken
[out] Указатель на маркер сообщения, который используется методом IMAPISession::ShowForm для доступа к сообщению, на которое указывает lpMessage.
Возвращаемое значение
S_OK
Подготовка формы прошла успешно.
Замечания
Метод IMAPISession::P repareForm создает маркер сообщения для сообщения, на которое указывает параметр lpMessage , и вызывает метод IUnknown::AddRef сообщения. Этот токен передается в параметре ulMessageToken в IMAPISession::ShowForm.
Примечания для вызывающих методов
Если вызов PrepareForm выполнен успешно, перед вызовом ShowForm опубликуйте сообщение, на которое указывает lpMessage, вызвав его метод IUnknown::Release. Сбой освобождения сообщения перед вызовом ShowForm может привести к утечке памяти.
Справочные материалы по MFCMAPI
Пример кода MFCMAPI указан в приведенной ниже таблице.
| Файл | Функция | Comment |
|---|---|---|
| MAPIFormFunctions.cpp |
OpenMessageModal |
MFCMAPI использует метод IMAPISession::P repareForm вместе с IMAPISession::ShowForm для отображения сообщения в модальной форме. |