IMAPIFolder::GetMessageStatus

适用于:Outlook 2013 | Outlook 2016

获取与特定文件夹中的邮件关联的状态 (例如,该邮件是否标记为要删除) 。

HRESULT GetMessageStatus(
  ULONG cbEntryID,
  LPENTRYID lpEntryID,
  ULONG ulFlags,
  ULONG FAR * lpulMessageStatus
);

参数

cbEntryID

[in] lpEntryID 参数指向的条目标识符中的字节计数。

lpEntryID

[in]指向已获取其状态的消息的条目标识符的指针。

ulFlags

[in]保留;必须为零。

lpulMessageStatus

[out]指向指示消息状态的标志的位掩码的指针的指针。 位 0 到 15 是保留的,必须为零;bits 16 到 31 可用于特定于实现的用途。 可以设置以下标志:

MSGSTATUS_DELMARKED

邮件已标记为要删除。

MSGSTATUS_HIDDEN

不会显示该消息。

MSGSTATUS_HIGHLIGHTED

消息将突出显示显示。

MSGSTATUS_REMOTE_DELETE

消息已标记为删除远程消息存储,而无需下载到本地客户端。

MSGSTATUS_REMOTE_DOWNLOAD

消息已标记为从远程消息存储下载到本地客户端。

MSGSTATUS_TAGGED

消息已标记为客户端定义的用途。

返回值

S_OK

已成功检索消息状态。

备注

IMAPIFolder::GetMessageStatus 方法返回消息的状态。 消息状态存储在邮件的 PR_MSG_STATUS (PidTagMessageStatus) 属性中。

针对实现者的说明

消息状态位的设置、清除和使用方式完全取决于你的实现,只是保留位 0 到 15,并且必须为零。 如果将消息存储在 IPM 子树中,MAPI 将保留 16 到 31 位供 IPM 客户端使用。 如果将消息存储在其他子树中,则可以将位 16 到 31 用于自己的目的。

MFCMAPI 引用

有关 MFCMAPI 示例代码,请参阅下表。

文件 函数 Comment
MyMAPIFormViewer.cpp
CMyMAPIFormViewer::GetNextMessage
MFCMAPI 使用 IMAPIFolder::GetMessageStatus 方法获取要显示的下一条消息的状态。
MAPIFormFunctions.cpp
OpenMessageNonModal 和 OpenMessageModal
MFCMAPI 使用 IMAPIFolder::GetMessageStatus 方法获取要传递给表单查看器(CMyMAPIFormViewer 或 IMAPISession::ShowForm)显示的消息的状态。

另请参阅

IMAPIFolder::SetMessageStatus

IMAPISession::ShowForm

PidTagMessageStatus 规范属性

IMAPIFolder : IMAPIContainer

MFCMAPI 代码示例