IMAPISession::SetDefaultStore
適用対象: Outlook 2013 | Outlook 2016
セッションの既定のメッセージ ストアとしてメッセージ ストアを確立します。
HRESULT SetDefaultStore(
ULONG ulFlags,
ULONG cbEntryID,
LPENTRYID lpEntryID
);
パラメーター
ulFlags
[in]既定のメッセージ ストアの設定を制御するフラグのビットマスク。 これらのフラグは相互に排他的です。設定できるのは、次のいずれかのフラグのみです。
MAPI_DEFAULT_STORE
メッセージ ストアをセッションの既定値として確立します。 PR_RESOURCE_FLAGS (PidTagResourceFlags) 列で STATUS_DEFAULT_STORE フラグを設定して、メッセージ ストアの状態テーブル行を更新します。
MAPI_PRIMARY_STORE
ログオン時に使用するストアとしてメッセージ ストアを確立します。 メッセージ ストアが既定のストアでない場合は、クライアントが既定のストアにする必要があります。 PR_RESOURCE_FLAGS列でSTATUS_PRIMARY_STORE フラグを設定して、メッセージ ストアの状態テーブル行を更新します。
MAPI_SECONDARY_STORE
プライマリ メッセージ ストアが使用できない場合は、ログオン時に使用するストアとしてメッセージ ストアを確立します。 クライアントがプライマリ ストアを開くことができない場合は、セカンダリ ストアを開き、既定として設定する必要があります。 PR_RESOURCE_FLAGS列でSTATUS_SECONDARY_STORE フラグを設定して、メッセージ ストアの状態テーブル行を更新します。
MAPI_SIMPLE_STORE_PERMANENT
メッセージ ストアのPR_RESOURCE_FLAGS プロパティの状態テーブル行、メッセージ ストア テーブル行、およびセッション プロファイルの STATUS_SIMPLE_STORE フラグを設定します。
MAPI_SIMPLE_STORE_TEMPORARY
メッセージ ストアのPR_RESOURCE_FLAGS プロパティの状態テーブル行とメッセージ ストア テーブル行の STATUS_SIMPLE_STORE フラグを設定します。 プロファイルは変更されません。
cbEntryID
[in] lpEntryID パラメーターによって指されるエントリ識別子のバイト数。
lpEntryID
[in]既定として意図されているメッセージ ストアのエントリ識別子へのポインター。 クライアントが lpEntryID で NULL を渡す場合、既定ではメッセージ ストアは選択されません。
戻り値
S_OK
呼び出しは成功し、期待される値または値を返しました。
注釈
IMAPISession::SetDefaultStore メソッドは、次のいずれかのメッセージ ストアを確立します。
セッションの既定のメッセージ ストア。
セッションのプライマリ メッセージ ストア。
セッションのセカンダリ メッセージ ストア。
メッセージ ストアを既定として確立するには、メッセージ ストアの PR_STORE_SUPPORT_MASK (PidTagStoreSupportMask) プロパティに次のフラグが設定されている必要があります。
STORE_SUBMIT_OK
STORE_CREATE_OK
STORE_MODIFY_OK
呼び出し側への注意
状態テーブルを取得し、 PR_RESOURCE_FLAGS列で STATUS_DEFAULT_STORE フラグの設定を検索することで、セッションの既定のメッセージ ストアを決定できます。 この設定の行は、セッションの既定値として指定されているメッセージ ストアを表します。
MAPI_DEFAULT_STOREまたはMAPI_SIMPLE_STORE_PERMANENT フラグが設定されている場合、MAPI はプロファイル、メッセージ ストア テーブル、および状態テーブルを更新します。
メッセージ ストアの既定の設定を変更するたびに、次の通知が生成されます。
fnevTableModified イベント通知は、メッセージ ストアと状態テーブルの両方の影響を受ける行ごとに発行されます。
MAPI スプーラーに内部通知が発行されます。 既に進行中の操作は変更なしで完了します。メッセージのダウンロードなど、既定のメッセージ ストアに関連する新しい操作は、新しい既定のストアに対して処理されます。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| MainDlg.cpp |
CMainDlg::OnSetDefaultStore |
MFCMAPI では、 IMAPISession::SetDefaultStore メソッドを使用して、選択したストアを既定のストアとして設定します。 |