HrValidateIPMSubtreeHrValidateIPMSubtree

適用されます: OutlookApplies to: Outlook

メッセージ ・ ストアには、標準的な個人間メッセージ (IPM) のフォルダーを追加します。Adds standard interpersonal message (IPM) folders to a message store.

ヘッダー ファイル:Header file:
Mapiutil.hMapiutil.h
によって実装されます。Implemented by:
MAPIMAPI
によって呼び出されます。Called by:
クライアント アプリケーションClient applications
HrValidateIPMSubtree(
  LPMDB lpMDB,
  ULONG ulFlags,
  ULONG FAR * lpcValues,
  LPSPropValue FAR * lppProps,
  LPMAPIERROR FAR * lppMapiError
);

ParametersParameters

lpMDBlpMDB

[in]メッセージへのポインターでは、フォルダーを追加するオブジェクトを格納します。[in] Pointer to the message store object to which to add the folders.

ulFlagsulFlags

[in]フォルダーを作成する方法を制御するために使用するフラグのビットマスクです。[in] Bitmask of flags used to control how the folders are created. 次のフラグを設定することができます。The following flags can be set:

MAPI_FORCE_CREATEMAPI_FORCE_CREATE

フォルダーは、メッセージ ・ ストア ・ プロパティの指定が有効である場合でも、作成する前に確認する必要があります。The folders should be verified before creation, even if message store properties indicate that they are valid. エラーは、既存のフォルダー構造が破損していることを示す場合、クライアント アプリケーションは通常このフラグを設定します。A client application typically sets this flag when an error indicates that the structure of an existing folder has been damaged.

MAPI_FULL_IPM_TREEMAPI_FULL_IPM_TREE

IPM フォルダーの完全なセットは、メッセージ ストアのルート フォルダーに作成してください。The full set of IPM folders should be created in the message store's root folder. 階層内のフォルダーのタイトルは次のとおりです。The folder titles in the hierarchy are:

- <span data-ttu-id="699a0-124">フォルダー ビュー</span><span class="sxs-lookup"><span data-stu-id="699a0-124">Folder Views</span></span>

- <span data-ttu-id="699a0-125">共通ビュー</span><span class="sxs-lookup"><span data-stu-id="699a0-125">Common Views</span></span>

- <span data-ttu-id="699a0-126">ルートを検索します。\*</span><span class="sxs-lookup"><span data-stu-id="699a0-126">Search Root\*</span></span>

- <span data-ttu-id="699a0-127">IPM サブツリー\*</span><span class="sxs-lookup"><span data-stu-id="699a0-127">IPM Subtree\*</span></span>

- <span data-ttu-id="699a0-128">受信トレイ</span><span class="sxs-lookup"><span data-stu-id="699a0-128">Inbox</span></span>

- <span data-ttu-id="699a0-129">送信トレイ</span><span class="sxs-lookup"><span data-stu-id="699a0-129">Outbox</span></span>

- <span data-ttu-id="699a0-130">削除済みアイテム\*</span><span class="sxs-lookup"><span data-stu-id="699a0-130">Deleted Items\*</span></span>

- <span data-ttu-id="699a0-131">送信済みアイテム</span><span class="sxs-lookup"><span data-stu-id="699a0-131">Sent Items</span></span>

<span data-ttu-id="699a0-132">3 つのフォルダーが付いて\*MAPI_FULL_IPM_TREE フラグが設定されていない場合でも作成される最小のセットです。</span><span class="sxs-lookup"><span data-stu-id="699a0-132">where the three folders marked with \* are the minimum set created even when the MAPI_FULL_IPM_TREE flag has not been set.</span></span> <span data-ttu-id="699a0-133">クライアント アプリケーションは、既定のストアでは、メッセージ ストアのフォルダーが作成されるときに通常このフラグを設定します。</span><span class="sxs-lookup"><span data-stu-id="699a0-133">A client application typically sets this flag when the message store in which the folders are to be created is the default store.</span></span>

lpcValueslpcValues

[で [チェック アウト]_LppProps_パラメーターで返される配列内のSPropValue構造体の数へのポインター。[in, out] Pointer to the number of SPropValue structures in the array returned in the lppProps parameter. _LppProps_が NULL の場合、 _lpcValues_パラメーターの値は 0 にすることができます。The value of the lpcValues parameter can be zero if lppProps is NULL.

lppPropslppProps

[で [チェック アウト]PR_VALID_FOLDER_MASK (PidTagValidFolderMask) は、適切なフォルダーのエントリの識別子のプロパティのプロパティ値を含むSPropValue構造体の配列へのポインターへのポインター。[in, out] Pointer to a pointer to an array of SPropValue structures that contains property values for the PR_VALID_FOLDER_MASK (PidTagValidFolderMask) property and for the appropriate folder entry identifier properties. SPropValue配列にはとしてコード化されたプロパティの特殊なタグで [受信トレイ] のエントリ id が含まれてHrValidateIPMSubtreeは、メッセージ ・ ストアの受信トレイを作成する場合PROP_TAG(PT_BINARY, PROP_ID_NULL)If HrValidateIPMSubtree creates an Inbox in the message store, the SPropValue array includes an Inbox entry identifier with a special property tag coded as PROP_TAG(PT_BINARY, PROP_ID_NULL). _LppProps_のパラメーターには、呼び出し元の実装をSPropValue配列が返されることをする必要がないことを示す、NULL を指定できます。The lppProps parameter can be NULL, indicating that the calling implementation does not require that an SPropValue array be returned.

lppMapiErrorlppMapiError

[out]エラーが発生するバージョン、コンポーネント、およびコンテキストの情報を格納するMAPIERROR構造体へのポインターへのポインター。[out] Pointer to a pointer to a MAPIERROR structure that contains version, component, and context information for an error. MAPIERROR構造体が返されない場合、 _lppMAPIError_パラメーターは NULL に設定します。The lppMAPIError parameter is set to NULL if no MAPIERROR structure is returned.

Return valueReturn value

なし。None.

備考Remarks

MAPI は、ストアを最初に開いたとき、またはストアが既定の保存を行った場合、メッセージ ストア内の標準の IPM サブツリーを作成するのには内部的にHrValidateIPMSubtree関数を使用します。MAPI uses the HrValidateIPMSubtree function internally to construct the standard IPM subtree in a message store when the store is first opened, or when a store is made the default store. この関数は、標準的なメッセージのフォルダーを修復または検証するクライアント アプリケーションによっても使用できます。This function can also be used by client applications to validate or repair standard message folders.

HrValidateIPMSubtreeは常に、ストアのルート フォルダーと IPM サブツリー フォルダー内の削除済みアイテム フォルダーのルートを検索し、IPM サブツリー フォルダーを作成します。HrValidateIPMSubtree always creates the Search Root and IPM Subtree folders in the store's root folder and the Deleted Items folder in the IPM Subtree folder. IPM サブツリー フォルダーは、そのメッセージ ・ ストアに IPM の階層のルートです。The IPM Subtree folder is the root of the IPM hierarchy in that message store. 検索のルート フォルダーは、検索結果フォルダーのサブツリーのルートとして使用できます。The Search Root folder can be used as the root of a subtree for search-results folders.

IPM のクライアントでは、IPM サブツリーのルート フォルダーから開始し、子の下にあるフォルダーを表示、フォルダーのビューを表示する必要があります。IPM clients should display their folder view starting at the IPM subtree root folder and showing child folders beneath it. メッセージ ストアのルート フォルダー内の情報は、クライアントのユーザー インターフェイスに表示されません。Information in the root folder of a message store should not appear in a client's user interface. この機能は、クライアントには、情報が非表示にする必要がありますと、情報ことができますが配置される IPM サブツリーのルート ディレクトリに、ユーザーに表示されていないことを示します。This functionality means that if a client must hide information, the information can be put in the IPM subtree root directory, where it is not visible to the user. 一方、IPM 以外のアプリケーション、サーバー ベースのメッセージ ・ ストアでは、ユーザーに表示するには、メッセージおよびフォルダーを必要とするまとめることができます IPM 階層に含まれない。In contrast, non-IPM applications that require messages and folders to be invisible to the user, for example in a server-based message store, can put them outside the IPM hierarchy.

HrValidateIPMSubtreeは、各 IPM フォルダーの作成が有効なエントリの識別子を持つかどうかを示すためにPR_VALID_FOLDER_MASKプロパティを設定します。HrValidateIPMSubtree sets the PR_VALID_FOLDER_MASK property to indicate whether each IPM folder it creates has a valid entry identifier. メッセージ ・ ストアの次のエントリの識別子プロパティは対応するフォルダーのエントリ id を設定し、 PR_VALID_FOLDER_MASKおよび_lppProps_パラメーターに返されます。The following entry identifier properties of the message store are set to the entry identifiers of the corresponding folders and returned in the lppProps parameter along with PR_VALID_FOLDER_MASK:

PR_COMMON_VIEWS_ENTRYID(PidTagCommonViewsEntryId)PR_COMMON_VIEWS_ENTRYID (PidTagCommonViewsEntryId)

PR_FINDER_ENTRYID(PidTagFinderEntryId)PR_FINDER_ENTRYID (PidTagFinderEntryId)

PR_IPM_OUTBOX_ENTRYID(PidTagIpmOutboxEntryId)PR_IPM_OUTBOX_ENTRYID (PidTagIpmOutboxEntryId)

PR_IPM_SENTMAIL_ENTRYID(PidTagIpmSentMailEntryId)PR_IPM_SENTMAIL_ENTRYID (PidTagIpmSentMailEntryId)

PR_IPM_SUBTREE_ENTRYID(PidTagIpmSubtreeEntryId)PR_IPM_SUBTREE_ENTRYID (PidTagIpmSubtreeEntryId)

PR_IPM_WASTEBASKET_ENTRYID(PidTagIpmWastebasketEntryId)PR_IPM_WASTEBASKET_ENTRYID (PidTagIpmWastebasketEntryId)

PR_VIEWS_ENTRYID(PidTagViewsEntryId)PR_VIEWS_ENTRYID (PidTagViewsEntryId)

プレース ホルダー (PT_BINARY, PROP_ID_NULL)、IPM の受信トレイにPROP_TAGA placeholder PROP_TAG for the IPM Inbox (PT_BINARY, PROP_ID_NULL).

MFCMAPI 参照MFCMAPI reference

MFCMAPI �T���v�� �R�[�h�ł́A���̕\��Q�Ƃ��Ă��������BFor MFCMAPI sample code, see the following table.

�t�@�C��File �֐�Function �R�����gComment
MstStoreDlg.cppMstStoreDlg.cpp
CMsgStoreDlg::OnValidateIPMSubtreeCMsgStoreDlg::OnValidateIPMSubtree
MFCMAPI では、 HrValidateIPMSubtreeメソッドを使用して、メッセージ ・ ストアに標準的なフォルダーを追加します。MFCMAPI uses the HrValidateIPMSubtree method to add standard folders to a message store.

関連項目See also

IMAPISession::OpenMsgStoreIMAPISession::OpenMsgStore

[�R��h �T���v���Ƃ��� MFCMAPIMFCMAPI as a Code Sample