IMAPIMessageSite::GetSiteStatus
適用対象: Outlook 2013 | Outlook 2016
現在のメッセージのメッセージ サイトの機能に関する情報をメッセージ サイト オブジェクトから返します。
HRESULT GetSiteStatus(
ULONG FAR * lpulStatus
);
パラメーター
lpulStatus
[out]メッセージの状態に関する情報を提供するフラグのビットマスクへのポインター。 次のフラグを設定できます。
VCSTATUS_COPY
メッセージはコピーできます。
VCSTATUS_DELETE
メッセージは削除できます。
VCSTATUS_DELETE_IS_MOVE
削除されると、メッセージはメッセージ ストアから直ちに削除されるのではなく、メッセージ ストア内の 削除済みアイテム フォルダーに移動されます。
VCSTATUS_MOVE
メッセージは移動できます。
VCSTATUS_NEW_MESSAGE
新しいメッセージを作成できます。
VCSTATUS_SAVE
メッセージは保存できます。
VCSTATUS_SUBMIT
メッセージは送信できます。
戻り値
S_OK
�ʘb���������A�\�������l�܂��͒l���Ԃ���܂��B
注釈
フォーム オブジェクトは IMAPIMessageSite::GetSiteStatus メソッドを呼び出して、現在のメッセージのメッセージ サイト オブジェクトの機能を取得します。 lpulStatus パラメーターで返されるフラグは、メッセージ サイトに関する情報を提供します。 通常、フォームは、フラグがメッセージ サイトの実装の機能に関して提供する情報に応じて、メニュー コマンドを有効または無効にします。 IPersistMessage::SaveCompleted メソッドまたは IPersistMessage::Load メソッドによって新しいメッセージがフォームに読み込まれる場合は、状態フラグをチェックする必要があります。 一部のメッセージ サイト オブジェクト (特に読み取り専用オブジェクト) では、メッセージを保存または削除できません。
実装に関するメモ
IMAPIMessageSite::GetSiteStatus メソッドでは、現在のメッセージに対して実行できる操作と実行できない操作を判断するために、クライアント アプリケーションが何らかの計算を行う必要がある場合があります。 通常、これは、現在のメッセージのメッセージ ストア プロバイダーの状態行を調べるか、ストア プロバイダーに対してクエリを実行して、クライアント アプリケーションがメッセージ ストアを使用して実行できるアクションを決定する必要があります。 たとえば、MAPI_DELETE_IS_MOVE フラグを返すかどうかを判断するには、メッセージ ストア オブジェクトのPR_IPM_WASTEBASKET_ENTRYID (PidTagIpmWastebasketEntryId) プロパティをチェックして、メッセージ ストアに Deleted Items フォルダーがあるかどうかを確認します。
フォーム サーバーに関連するインターフェイスの一覧については、「 MAPI フォーム インターフェイス」を参照してください。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| MyMAPIFormViewer.cpp |
CMyMAPIFormViewer::GetSiteStatus |
MFCMAPI では、 IMAPIMessageSite::GetSiteStatus メソッドを使用して、指定したサイトの状態を取得します。 VCSTATUS_NEW_MESSAGE、VCSTATUS_SAVE、またはVCSTATUS_SUBMITを返すことができます。 |
関連項目
IPersistMessage::SaveCompleted