HrValidateIPMSubtree

[アーティクル]
04/04/2023

適用対象: Outlook 2013 | Outlook 2016

標準の対人メッセージ (IPM) フォルダーをメッセージストアに追加します。

プロパティ	値
ヘッダーファイル:	Mapiutil.h
実装元:	MAPI
呼び出し元:	クライアントアプリケーション

HrValidateIPMSubtree(
  LPMDB lpMDB,
  ULONG ulFlags,
  ULONG FAR * lpcValues,
  LPSPropValue FAR * lppProps,
  LPMAPIERROR FAR * lppMapiError
);

パラメーター

lpMDB

[in]フォルダーを追加するメッセージストアオブジェクトへのポインター。

ulFlags

[in]フォルダーの作成方法を制御するために使用されるフラグのビットマスク。次のフラグを設定できます。

MAPI_FORCE_CREATE

フォルダーは、メッセージストアのプロパティが有効であることを示している場合でも、作成前に確認する必要があります。クライアントアプリケーションは、通常、既存のフォルダーの構造が破損していることを示すエラーが発生したときに、このフラグを設定します。

MAPI_FULL_IPM_TREE

IPM フォルダーの完全なセットは、メッセージストアのルートフォルダーに作成する必要があります。階層内のフォルダータイトルは次のとおりです。

フォルダービュー
共通ビュー
検索ルート*
IPM サブツリー*
受信トレイ
送信トレイ
削除済みアイテム*
送信済みアイテム

ここで、 * でマークされた 3 つのフォルダーは、MAPI_FULL_IPM_TREE フラグが設定されていない場合でも作成される最小セットです。通常、クライアントアプリケーションは、フォルダーを作成するメッセージストアが既定のストアである場合に、このフラグを設定します。

lpcValues

[in, out]lppProps パラメーターで返される配列内の SPropValue 構造体の数へのポインター。 lppProps が NULL の場合、lpcValues パラメーターの値は 0 にすることができます。

lppProps

[in, out]PR_VALID_FOLDER_MASK (PidTagValidFolderMask) プロパティと適切なフォルダーエントリ識別子プロパティのプロパティ値を含む SPropValue 構造体の配列へのポインター。 HrValidateIPMSubtree がメッセージストアに受信トレイを作成する場合、SPropValue 配列には、特殊なプロパティタグがとしてPROP_TAG(PT_BINARY, PROP_ID_NULL)コード化された受信トレイエントリ識別子が含まれます。 lppProps パラメーターには NULL を指定できます。呼び出し元の実装で SPropValue 配列を返す必要はないことを示します。

lppMapiError

[out]エラーのバージョン、コンポーネント、コンテキスト情報を含む MAPIERROR 構造体へのポインターへのポインター。 MAPIERROR 構造体が返されない場合、lppMAPIError パラメーターは NULL に設定されます。

戻り値

なし。

注釈

MAPI では、 HrValidateIPMSubtree 関数を内部的に使用して、ストアが最初に開かれるとき、またはストアが既定のストアになったときに、メッセージストアに標準 IPM サブツリーを構築します。この関数は、クライアントアプリケーションが標準メッセージフォルダーを検証または修復するためにも使用できます。

HrValidateIPMSubtree は、常にストアのルートフォルダーに検索ルートフォルダーと IPM サブツリーフォルダーを作成し、IPM サブツリーフォルダーの削除済みアイテムフォルダーを作成します。 IPM サブツリーフォルダーは、そのメッセージストア内の IPM 階層のルートです。検索ルートフォルダーは、検索結果フォルダーのサブツリーのルートとして使用できます。

IPM クライアントは、IPM サブツリールートフォルダーから始まり、その下に子フォルダーを表示するフォルダービューを表示する必要があります。メッセージストアのルートフォルダー内の情報は、クライアントのユーザーインターフェイスに表示しないでください。この機能は、クライアントが情報を非表示にする必要がある場合は、IPM サブツリールートディレクトリに情報を配置できることを意味します。このディレクトリは、ユーザーには表示されません。一方、サーバーベースのメッセージストアなど、メッセージやフォルダーをユーザーに表示しない必要がある IPM 以外のアプリケーションは、IPM 階層の外部に配置できます。

HrValidateIPMSubtree は 、PR_VALID_FOLDER_MASK プロパティを設定して、作成する各 IPM フォルダーに有効なエントリ識別子があるかどうかを示します。メッセージストアの次のエントリ識別子プロパティは、対応するフォルダーのエントリ識別子に設定され、PR_VALID_FOLDER_MASKと共に lppProps パラメーターで返されます。

PR_COMMON_VIEWS_ENTRYID (PidTagCommonViewsEntryId)

PR_FINDER_ENTRYID (PidTagFinderEntryId)

PR_IPM_OUTBOX_ENTRYID (PidTagIpmOutboxEntryId)

PR_IPM_SENTMAIL_ENTRYID (PidTagIpmSentMailEntryId)

PR_IPM_SUBTREE_ENTRYID (PidTagIpmSubtreeEntryId)

PR_IPM_WASTEBASKET_ENTRYID (PidTagIpmWastebasketEntryId)

PR_VIEWS_ENTRYID (PidTagViewsEntryId)

IPM 受信トレイ ( PT_BINARY 、PROP_ID_NULL) のプレースホルダー PROP_TAG。

MFCMAPI リファレンス

MFCMAPI のサンプルコードについては、次の表を参照してください。

ファイル	関数	コメント
MstStoreDlg.cpp	CMsgStoreDlg::OnValidateIPMSubtree	MFCMAPI では、HrValidateIPMSubtree メソッドを使用して、標準フォルダーをメッセージストアに追加します。

HrValidateIPMSubtree

パラメーター

戻り値

注釈

MFCMAPI リファレンス

関連項目

その他のリソース