IMAPIFormMgr::LoadForm
适用于:Outlook 2013 | Outlook 2016
启动窗体以打开现有邮件。
HRESULT LoadForm(
ULONG_PTR ulUIParam,
ULONG ulFlags,
LPCSTR lpszMessageClass,
ULONG ulMessageStatus,
ULONG ulMessageFlags,
LPMAPIFOLDER pFolderFocus,
LPMAPIMESSAGESITE pMessageSite,
LPMESSAGE pmsg,
LPMAPIVIEWCONTEXT pViewContext,
REFIID riid,
LPVOID FAR * ppvObj
);
参数
ulUIParam
[in]打开窗体时显示的进度指示器父窗口的句柄。 除非在 ulFlags 参数中设置了 MAPI_DIALOG 标志,否则忽略 ulUIParam 参数。
ulFlags
[in]控制窗体的打开方式的标志的位掩码。 可以设置以下标志:
MAPI_DIALOG
显示用户界面以提供状态或提示用户了解详细信息。 如果未设置此标志,则不显示任何用户界面。
MAPIFORM_EXACTMATCH
仅应解析完全匹配的消息类字符串。
lpszMessageClass
[in]指向字符串的指针,该字符串命名要加载的消息的消息类。 如果在 lpszMessageClass 参数中传递 NULL,则从 pmsg 参数指向的消息确定消息类。
ulMessageStatus
[in]从 PR_MSG_STATUS 复制的客户端定义标志或提供程序定义的标志的位掩码 (PidTagMessageStatus) 消息的属性,该属性提供有关消息状态的信息。 如果 lpszMessageClass 为非 NULL,则必须设置 ulMessageStatus 参数;否则,忽略 ulMessageStatus 。
ulMessageFlags
[in]指向从 PR_MESSAGE_FLAGS 复制的标志的位掩码的指针 (PidTagMessageFlags) 消息的属性,该属性指示消息的当前状态。 如果 lpszMessageClass 为非 NULL,则必须设置 ulMessageFlags 参数;否则,忽略 ulMessageFlags。
pFolderFocus
[in]指向直接包含邮件的文件夹的指针。 如果 (不存在此类文件夹,则 pFolderFocus 参数可以为 NULL,例如,如果邮件嵌入另一封邮件) 中。
pMessageSite
[in]指向消息的消息站点的指针。
pmsg
[in]指向消息的指针。
pViewContext
[in]指向消息的视图上下文的指针。 pViewContext 参数可以为 NULL。
riid
[in]接口标识符 (要用于返回的窗体对象的接口的 IID) 。 riid 参数不能为 NULL。
ppvObj
[out]指向返回接口的指针的指针。
返回值
S_OK
调用成功,并返回了预期的值。
MAPI_E_NO_INTERFACE
窗体不支持请求的接口。
MAPI_E_NOT_FOUND
lpszMessageClass 中传递的邮件类与表单库中任何窗体的邮件类都不匹配。
备注
表单查看者调用 IMAPIFormMgr::LoadForm 方法以打开现有邮件的窗体。 LoadForm 将打开窗体对象,将消息加载到窗体对象中,根据需要设置适当的视图上下文,并返回表单对象的请求接口。
pFolderFocus 参数指向包含邮件的文件夹。 如果消息嵌入到另一条消息中, pFolderFocus 应为 NULL。
针对实现者的说明
如果在 lpszMessageClass 中传递 NULL,则实现将从消息的 PR_MESSAGE_CLASS 获取消息的消息类、状态和标志 (PidTagMessageClass) 、 PR_MSG_STATUS 和 PR_MESSAGE_FLAGS 属性。 如果在 lpszMessageClass 中提供了消息类字符串,则实现必须使用 ulMessageStatus 和 ulMessageFlags 中的值。
MFCMAPI 引用
有关 MFCMAPI 示例代码,请参阅下表。
文件 | 函数 | Comment |
---|---|---|
MAPIFormFunctions.cpp |
OpenMessageNonModal |
MFCMAPI 使用 IMAPIFormMgr::LoadForm 方法在显示窗体之前加载窗体。 |
另请参阅
PidTagMessageClass 规范属性
PidTagMessageFlags 规范属性
PidTagMessageStatus 规范属性
IMAPIFormMgr:IUnknownMFCMAPI 作为代码示例