IMsgStore::GetReceiveFolder
Gilt für: Outlook 2013 | Outlook 2016
Ruft den Ordner ab, der als Ziel für eingehende Nachrichten einer angegebenen Nachrichtenklasse oder als Standardmäßiger Empfangsordner für den Nachrichtenspeicher eingerichtet wurde.
HRESULT GetReceiveFolder(
LPSTR lpszMessageClass,
ULONG ulFlags,
ULONG FAR * lpcbEntryID,
LPENTRYID FAR * lppEntryID,
LPSTR FAR * lppszExplicitClass
);
Parameter
lpszMessageClass
[in] Ein Zeiger auf eine Nachrichtenklasse, die einem Empfangsordner zugeordnet ist. Wenn der lpszMessageClass-Parameter auf NULL oder eine leere Zeichenfolge festgelegt ist, gibt GetReceiveFolder den Standardmäßigen Empfangsordner für den Nachrichtenspeicher zurück.
ulFlags
[in] Eine Bitmaske von Flags, die den Typ der übergebenen und zurückgegebenen Zeichenfolgen steuert. Das folgende Flag kann festgelegt werden:
MAPI_UNICODE
Die Nachrichtenklassenzeichenfolge weist das Unicode-Format auf. Wenn das MAPI_UNICODE-Flag nicht festgelegt ist, weist die Nachrichtenklassenzeichenfolge das ANSI-Format auf.
lpcbEntryID
[out] Ein Zeiger auf die Byteanzahl im Eintragsbezeichner, auf den der lppEntryID-Parameter verweist.
lppEntryID
[out] Ein Zeiger auf einen Zeiger auf den Eintragsbezeichner für den angeforderten Empfangsordner.
lppszExplicitClass
[out] Ein Zeiger auf einen Zeiger auf die Nachrichtenklasse, die explizit als Empfangsordner den Ordner festlegt, auf den lppEntryID verweist. Diese Nachrichtenklasse sollte entweder mit der -Klasse im lpszMessageClass-Parameter oder einer Basisklasse dieser Klasse identisch sein. Die Übergabe von NULL gibt an, dass der Ordner, auf den lppEntryID verweist, der Standardordner für den Nachrichtenspeicher ist.
Rückgabewert
S_OK
Der Empfangsordner wurde erfolgreich zurückgegeben.
Hinweise
Die IMsgStore::GetReceiveFolder-Methode ruft den Eintragsbezeichner eines Empfangsordners ab, einem Ordner, der zum Empfangen eingehender Nachrichten einer bestimmten Nachrichtenklasse bestimmt ist. Aufrufer können eine Nachrichtenklasse oder NULL im lpszMessageClass-Parameter angeben. Wenn lpszMessageClass NULL ist, gibt GetReceiveFolder die folgenden Werte zurück:
In lppszExplicitClass der Name der ersten Basisklasse der Nachrichtenklasse, auf die von lpszMessageClass verwiesen wird, die explizit einen Empfangsordner festgelegt.
In lppEntryID der Eintragsbezeichner des Empfangsordners für die Basisklasse, auf die der lppszExplicitClass-Parameter verweist.
Angenommen, der Empfangsordner der Nachrichtenklasse IPM. Hinweis wurde auf den Eintragsbezeichner des Posteingangs festgelegt, und GetReceiveFolder wird aufgerufen, wobei der Inhalt von lpszMessageClass auf IPM festgelegt ist. Note.Phone. Wenn IPM. Hinweis.Phone hat keinen expliziten Empfangsordner festgelegt. GetReceiveFolder gibt den Eintragsbezeichner des Posteingangs in lppEntryID und IPM zurück. Hinweis in lppszExplicitClass.
Wenn der Client GetReceiveFolder für eine Nachrichtenklasse aufruft und keinen Empfangsordner für diese Nachrichtenklasse festgelegt hat, ist lppszExplicitClass entweder eine leere Zeichenfolge, eine Zeichenfolge im Unicode-Format oder eine Zeichenfolge im ANSI-Format, je nachdem, ob der Client das MAPI_UNICODE Flag im ulFlags-Parameter festgelegt hat.
Für jeden Nachrichtenspeicher ist immer ein Standardmäßiger Empfangsordner vorhanden, der durch Übergeben von NULL im lpszMessageClass-Parameter abgerufen wird.
Ein Client sollte die MAPIFreeBuffer-Funktion aufrufen, wenn dies mit dem in lppEntryID zurückgegebenen Eintragsbezeichner erfolgt ist, um den Arbeitsspeicher freizugeben, der diesen Eintragsbezeichner enthält. Außerdem sollte MAPIFreeBuffer aufgerufen werden, wenn dies mit der in lppszExplicitClass zurückgegebenen Nachrichtenklassenzeichenfolge erfolgt, um den Speicher freizugeben, der diese Zeichenfolge enthält.
MFCMAPI-Referenz
Einen MFCMAP-Beispielcode finden Sie in der folgenden Tabelle.
| Datei | Funktion | Kommentar |
|---|---|---|
| MAPIFunctions.cpp |
GetInbox |
MFCMAPI verwendet die IMsgStore::GetReceiveFolder-Methode , um den Ordner Posteingang zu suchen. |