IMsgStore::GetReceiveFolder

Article
04/04/2023

S’applique à : Outlook 2013 | Outlook 2016

Obtient le dossier qui a été établi comme destination pour les messages entrants d’une classe de message spécifiée ou comme dossier de réception par défaut pour la banque de messages.

HRESULT GetReceiveFolder(
  LPSTR lpszMessageClass,
  ULONG ulFlags,
  ULONG FAR * lpcbEntryID,
  LPENTRYID FAR * lppEntryID,
  LPSTR FAR * lppszExplicitClass
);

Paramètres

lpszMessageClass

[in] Pointeur vers une classe de message associée à un dossier de réception. Si le paramètre lpszMessageClass a la valeur NULL ou une chaîne vide, GetReceiveFolder retourne le dossier de réception par défaut pour la banque de messages.

ulFlags

[in] Masque de bits d’indicateurs qui contrôle le type des chaînes transmises et retournées. L’indicateur suivant peut être défini :

MAPI_UNICODE

La chaîne de classe de message est au format Unicode. Si l’indicateur MAPI_UNICODE n’est pas défini, la chaîne de classe de message est au format ANSI.

lpcbEntryID

[out] Pointeur vers le nombre d’octets dans l’identificateur d’entrée vers lequel pointe le paramètre lppEntryID .

lppEntryID

[out] Pointeur vers un pointeur vers l’identificateur d’entrée du dossier de réception demandé.

lppszExplicitClass

[out] Pointeur vers un pointeur vers la classe de message qui définit explicitement comme dossier de réception le dossier pointé par lppEntryID. Cette classe de message doit être identique à la classe dans le paramètre lpszMessageClass ou à une classe de base de cette classe. La transmission de la valeur NULL indique que le dossier pointé par lppEntryID est le dossier de réception par défaut pour la banque de messages.

Valeur renvoyée

S_OK

Le dossier de réception a été retourné avec succès.

Remarques

La méthode IMsgStore ::GetReceiveFolder obtient l’identificateur d’entrée d’un dossier de réception, un dossier désigné pour recevoir les messages entrants d’une classe de message particulière. Les appelants peuvent spécifier une classe de message ou NULL dans le paramètre lpszMessageClass . Si lpszMessageClass a la valeur NULL, GetReceiveFolder retourne les valeurs suivantes :

Dans lppszExplicitClass, nom de la première classe de base de la classe de message pointée vers lpszMessageClass qui définit explicitement un dossier de réception.
Dans lppEntryID, identificateur d’entrée du dossier receive pour la classe de base vers laquelle pointe le paramètre lppszExplicitClass .

Par exemple, supposons que le dossier receive de la classe de message IPM. Remarque a été défini sur l’identificateur d’entrée de la boîte de réception et GetReceiveFolder est appelé avec le contenu de lpszMessageClass défini sur IPM. Remarque.Téléphone. Si IPM. Remarque.Phone n’a pas de dossier de réception explicite défini, GetReceiveFolder retourne l’identificateur d’entrée de la boîte de réception dans lppEntryID et IPM. Remarque dans lppszExplicitClass.

Si le client appelle GetReceiveFolder pour une classe de message et n’a pas défini de dossier de réception pour cette classe de message, lppszExplicitClass est une chaîne de longueur nulle, une chaîne au format Unicode ou une chaîne au format ANSI selon que le client a défini l’indicateur MAPI_UNICODE dans le paramètre ulFlags .

Un dossier de réception par défaut, obtenu en passant NULL dans le paramètre lpszMessageClass , existe toujours pour chaque magasin de messages.

Un client doit appeler la fonction MAPIFreeBuffer lorsqu’il a terminé avec l’identificateur d’entrée retourné dans lppEntryID pour libérer la mémoire qui contient cet identificateur d’entrée. Il doit également appeler MAPIFreeBuffer quand il est terminé avec la chaîne de classe de message retournée dans lppszExplicitClass pour libérer la mémoire qui contient cette chaîne.

Référence MFCMAPI

Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.

Fichier	Fonction	Commentaire
MAPIFunctions.cpp	GetInbox	MFCMAPI utilise la méthode IMsgStore ::GetReceiveFolder pour localiser le dossier Boîte de réception.

Voir aussi

MAPIFreeBuffer
IMsgStore : IMAPIProp MFCMAPI en tant qu’exemple de code

Partager via