IXPLogon::FlushQueues

适用于:Outlook 2013 | Outlook 2016

请求传输提供程序立即传递所有挂起的入站或出站消息。

HRESULT FlushQueues(
  ULONG_PTR ulUIParam,
  ULONG cbTargetTransport,
  LPENTRYID lpTargetTransport,
  ULONG ulFlags
);

参数

ulUIParam

[in]此方法显示的任何对话框或窗口的父窗口的句柄。

cbTargetTransport

[in]保留;必须为零。

lpTargetTransport

[in]保留;必须为 NULL。

ulFlags

[in]控制如何完成消息队列刷新的标志的位掩码。 可以设置以下标志:

FLUSH_DOWNLOAD

应刷新入站消息队列或队列。

FLUSH_FORCE

传输提供程序应处理此请求(如果可能),即使这样做很耗时。

FLUSH_NO_UI

传输提供程序不应显示用户界面。

FLUSH_UPLOAD

应刷新出站消息队列或队列。

返回值

S_OK

调用成功并返回了一个或多个预期值。

备注

MAPI 后台处理程序调用 IXPLogon::FlushQueues 方法,告知传输提供程序 MAPI 后台处理程序即将开始处理消息。 传输提供程序应调用 IMAPISupport::ModifyStatusRow 方法,以在其状态行 的 PR_STATUS_CODE (PidTagStatusCode) 属性中为其状态设置适当的位。 更新其状态行后,传输提供程序应为 FlushQueues 调用返回S_OK。 然后,MAPI 后台处理程序开始发送消息,操作与 MAPI 后台处理程序同步。

为了支持 IMAPIStatus::FlushQueues 方法的实现,MAPI 后台处理程序为配置文件会话中运行的活动传输提供程序的所有登录对象调用 IXPLogon::FlushQueues 。 当由于客户端应用程序调用 IMAPIStatus::FlushQueues 而调用传输提供程序的 FlushQueues 方法时,消息处理以异步方式对客户端进行。

另请参阅

IMAPIStatus::FlushQueues

IXPLogon : IUnknown