IMAPISupport::StoreLogoffTransportsIMAPISupport::StoreLogoffTransports

適用されます: OutlookApplies to: Outlook

メッセージ ストアの正常型解放を要求します。Requests the orderly release of a message store.

HRESULT StoreLogoffTransports(
ULONG FAR * lpulFlags
);

ParametersParameters

lpulFlagslpulFlags

[で [チェック アウト]メッセージ ストアのログオフが行われる方法を制御するフラグのビットマスクです。[in, out] A bitmask of flags that controls how message store logoff occurs. 入力ではこのパラメーターのすべてのフラグは相互に排他的です。呼び出しは、次のフラグの 1 つだけを設定できます。On input, all flags for this parameter are mutually exclusive; only one of the following flags can be set per call:

LOGOFF_ABORTLOGOFF_ABORT

ログオフする前に、このストア用のトランスポート プロバイダーのアクティビティを停止する必要があります。Any transport provider activity for this store should be stopped before logoff. 活動が停止し、MAPI スプーラーがストアにログオフした後、コントロールがクライアントに返されます。Control is returned to the client after the activity is stopped and the MAPI spooler has logged off the store. 場合は、任意のトランスポート処理が行われて、ログオフが発生しないと、MAPI スプーラーまたはトランスポート プロバイダーの動作の変更は行われません。If any transport activity is taking place, the logoff does not occur and no change in the MAPI spooler or transport provider behavior occurs. 現在の活動はありません、MAPI スプーラーは、ストアを解放します。If there is currently no activity, the MAPI spooler releases the store.

LOGOFF_NO_WAITLOGOFF_NO_WAIT

MAPI スプーラーは、ストアを解放し、すべての送信メールを送信する準備が整っているが送信された直後に、コントロールをクライアントに返す必要があります。The MAPI spooler should release the store and return control to the client immediately after all outbound mail that is ready to be sent is sent. メッセージ ・ ストアに既定の受信トレイがある場合は、任意のプロセスでメッセージを受信すると、それ以上の受信が無効になります。If the message store has the default Inbox, any in-process message is received, and then further reception is disabled.

LOGOFF_ORDERLYLOGOFF_ORDERLY

MAPI スプーラーが、ストアを解放し、保留中のメッセージが終了した後すぐにクライアントに制御を返す必要がありますを処理します。The MAPI spooler should release the store and return control to the client immediately after any pending messages are finished processing. 新しいメッセージは処理されません。No new messages should be processed.

LOGOFF_PURGELOGOFF_PURGE

LOGOFF_NO_WAIT フラグと同じように動作します。Works the same as the LOGOFF_NO_WAIT flag. LOGOFF_PURGE フラグは、完了した後、呼び出し側にコントロールを返します。The LOGOFF_PURGE flag returns control to the caller after completion.

LOGOFF_QUIETLOGOFF_QUIET

ログオフする必要がありますトランスポート プロバイダーのすべてのアクティビティが行われる場合は発生しません。The logoff should not occur if any transport provider activity is taking place. 出力フラグとして実行されているアクティビティの種類が返されます。The type of activity taking place is returned as a flag on output.

On output, MAPI spooler can return one or more of the following flags:

LOGOFF_COMPLETELOGOFF_COMPLETE

ログオフを完了できます。The logoff can complete. ストアに関連付けられているすべてのリソースが解放されているし、オブジェクトが無効になっています。All resources associated with the store have been released, and the object has been invalidated. MAPI スプーラーを実行しているか、すべての要求が実行されます。The MAPI spooler has performed or will perform all requests. この時点で、メッセージ ・ ストアのリ スのメソッドのみを呼び出す必要があります。Only the message store's IUnknown::Release method should be called at this point.

LOGOFF_INBOUNDLOGOFF_INBOUND

メッセージ現在に由来してストアに 1 つまたは複数のトランスポート プロバイダー。A message is currently coming into the store from one or more transport providers.

LOGOFF_OUTBOUNDLOGOFF_OUTBOUND

1 つまたは複数のトランスポート プロバイダーによって、ストアからメッセージを送信されている現在は。A message is currently being sent from the store by one or more transport providers.

LOGOFF_OUTBOUND_QUEUELOGOFF_OUTBOUND_QUEUE

ストアの送信キューには現在のメッセージがあります。There are currently messages in the outbound queue for the store.

�߂�lReturn value

S_OKS_OK

ログオフ プロシージャが正常に完了しました。The logoff procedure was successful.

備考Remarks

メッセージ ストア プロバイダーのサポート オブジェクトのIMAPISupport::StoreLogoffTransportsメソッドを実装します。The IMAPISupport::StoreLogoffTransports method is implemented for message store provider support objects. メッセージ ストア プロバイダーは、クライアント アプリケーションにメッセージ ・ ストアとして MAPI ハンドル トランスポート プロバイダーのアクティビティを終了する方法をある程度制御を提供するStoreLogoffTransportsを呼び出します。Message store providers call StoreLogoffTransports to give client applications some control over how MAPI handles transport provider activity as a message store is closing.

別のプロセスに同じプロファイルを開いてログオフするのには、ストアがある場合は、MAPI はStoreLogoffTransportsへの呼び出しを無視し、 _lpulFlags_パラメーターに LOGOFF_COMPLETE フラグを返します。If another process has the store to be logged off open for the same profile, MAPI ignores a call to StoreLogoffTransports and returns the flag LOGOFF_COMPLETE in the lpulFlags parameter.

StoreLogoffTransportsからの戻り値を次のストア プロバイダーの動作は、 _lpulFlags_システムの状態を示し、ログオフ時の動作については、クライアントに伝達するの値に基づいている必要があります。The behavior of the store provider following the return from StoreLogoffTransports should be based on the value of lpulFlags, which indicates system status and conveys client instructions for logoff behavior.

呼び出し側への注意Notes to callers

StoreLogoffTransportsは、通常、ストア プロバイダーのIMsgStore::StoreLogoffメソッドから呼び出されます。StoreLogoffTransports is typically called from a store provider's IMsgStore::StoreLogoff method. ただしに呼び出すこともできますメソッドのメッセージ ・ ストアから。However, it can also be called from the IUnknown::Release method of the message store. 実装するStoreLogoffTransportsへの呼び出しが開始されているかどうかを確認することができますので、メッセージ ・ ストアのReleaseメソッドが発生しました。Implement the Release method of your message store so you can check whether or not a call to StoreLogoffTransports has occurred. 呼び出しが実行されていない場合は、LOGOFF_ABORT フラグを設定してStoreLogoffTransportsを呼び出します。If a call has not occurred, call StoreLogoffTransports with the LOGOFF_ABORT flag set.

_LpulFlags_パラメーターは、クライアントがメッセージ ・ ストアをシャット ダウンする必要がありますを示すフラグを設定します。The lpulFlags parameter is set to a flag that indicates how the client requires the message store to be shut down. UlFlags StoreLogoffへの呼び出しに対応するパラメーターの設定に基づいて適切な設定を決定します。Determine the appropriate setting for ulFlags based on the setting of the corresponding parameter in the call to StoreLogoff. クライアントには、 ulFlags LOGOFF_ORDERLY に設定すると、 StoreLogoffメソッドが呼び出されると、 _ulFlags_に LOGOFF_ORDERLY の設定でStoreLogoffTransportsを呼び出す必要があります。That is, if a client called your StoreLogoff method with ulFlags set to LOGOFF_ORDERLY, you should call StoreLogoffTransports with ulFlags set to LOGOFF_ORDERLY.

メッセージ ストア ログオフ処理の詳細については、シャット ダウン、メッセージ ストア プロバイダーを参照してください。For more information about the message store logoff process, see Shutting Down a Message Store Provider.

関連項目See also

IMsgStore::StoreLogoffIMsgStore::StoreLogoff

IXPLogon::FlushQueuesIXPLogon::FlushQueues

IMAPISupport: IUnknownIMAPISupport : IUnknown