IMsgStore::GetReceiveFolder
適用対象: Outlook 2013 | Outlook 2016
指定したメッセージ クラスの受信メッセージの送信先として、またはメッセージ ストアの既定の受信フォルダーとして確立されたフォルダーを取得します。
HRESULT GetReceiveFolder(
LPSTR lpszMessageClass,
ULONG ulFlags,
ULONG FAR * lpcbEntryID,
LPENTRYID FAR * lppEntryID,
LPSTR FAR * lppszExplicitClass
);
パラメーター
lpszMessageClass
[in]受信フォルダーに関連付けられているメッセージ クラスへのポインター。 lpszMessageClass パラメーターが NULL または空の文字列に設定されている場合、GetReceiveFolder はメッセージ ストアの既定の受信フォルダーを返します。
ulFlags
[in]渡された文字列と返される文字列の型を制御するフラグのビットマスク。 次のフラグを設定できます。
MAPI_UNICODE
メッセージ クラスの文字列は Unicode 形式です。 MAPI_UNICODE フラグが設定されていない場合、メッセージ クラス文字列は ANSI 形式です。
lpcbEntryID
[out] lppEntryID パラメーターによって指されるエントリ識別子のバイト数へのポインター。
lppEntryID
[out]要求された受信フォルダーのエントリ識別子へのポインターへのポインター。
lppszExplicitClass
[out] lppEntryID が指すフォルダーを受信フォルダーとして明示的に設定するメッセージ クラスへのポインターへのポインター。 このメッセージ クラスは、 lpszMessageClass パラメーターのクラスと同じか、そのクラスの基底クラスである必要があります。 NULL を渡すと、 lppEntryID が指すフォルダーがメッセージ ストアの既定の受信フォルダーであることを示します。
戻り値
S_OK
受信フォルダーが正常に返されました。
注釈
IMsgStore::GetReceiveFolder メソッドは、特定のメッセージ クラスの受信メッセージを受信するために指定されたフォルダーである受信フォルダーのエントリ識別子を取得します。 呼び出し元は、 lpszMessageClass パラメーターでメッセージ クラスまたは NULL を指定できます。 lpszMessageClass が NULL の場合、GetReceiveFolder は次の値を返します。
lppszExplicitClass では、受信フォルダーを明示的に設定する lpszMessageClass によって指されるメッセージ クラスの最初の基底クラスの名前。
lppEntryID では、lppszExplicitClass パラメーターによって指される基底クラスの受信フォルダーのエントリ識別子。
たとえば、メッセージ クラス IPM の受信フォルダーがあるとします 。メモ は受信トレイのエントリ識別子に設定されており、 getReceiveFolder は lpszMessageClass の内容を IPM に設定して呼び出されます 。Note.Phone。 IPM の場合。注.Phone には明示的な受信フォルダーが設定されていません。GetReceiveFolder は、受信トレイのエントリ識別子を lppEntryID と IPM で返します。lppszExplicitClass に注意してください。
クライアントがメッセージ クラスに 対して GetReceiveFolder を 呼び出し、そのメッセージ クラスの受信フォルダーを設定していない場合、 lppszExplicitClass は、クライアントが ulFlags パラメーターにMAPI_UNICODE フラグを設定するかどうかに応じて、長さ 0 の文字列、Unicode 形式の文字列、または ANSI 形式の文字列のいずれかになります。
lpszMessageClass パラメーターに NULL を渡すことによって取得された既定の受信フォルダーは、常にすべてのメッセージ ストアに存在します。
クライアントは、lppEntryID で返されるエントリ識別子を使用して MAPIFreeBuffer 関数を呼び出して、そのエントリ識別子を保持するメモリを解放する必要があります。 また、lppszExplicitClass で返されるメッセージ クラス文字列を使用して、その文字列を保持するメモリを解放するときにも MAPIFreeBuffer を呼び出す必要があります。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| MAPIFunctions.cpp |
GetInbox |
MFCMAPI では 、IMsgStore::GetReceiveFolder メソッドを使用して受信トレイ フォルダーを検索します。 |