IMAPIFormMgr::LoadForm

Article
04/04/2023

S’applique à : Outlook 2013 | Outlook 2016

Démarre un formulaire pour ouvrir un message existant.

HRESULT LoadForm(
  ULONG_PTR ulUIParam,
  ULONG ulFlags,
  LPCSTR lpszMessageClass,
  ULONG ulMessageStatus,
  ULONG ulMessageFlags,
  LPMAPIFOLDER pFolderFocus,
  LPMAPIMESSAGESITE pMessageSite,
  LPMESSAGE pmsg,
  LPMAPIVIEWCONTEXT pViewContext,
  REFIID riid,
  LPVOID FAR * ppvObj
);

Paramètres

ulUIParam

[in] Handle de la fenêtre parente de l’indicateur de progression affiché lors de l’ouverture du formulaire. Le paramètre ulUIParam est ignoré, sauf si l’indicateur MAPI_DIALOG est défini dans le paramètre ulFlags .

ulFlags

[in] Masque de bits d’indicateurs qui contrôle la façon dont le formulaire est ouvert. Les indicateurs suivants peuvent être définis :

MAPI_DIALOG

Affiche une interface utilisateur pour fournir status ou inviter l’utilisateur à obtenir plus d’informations. Si cet indicateur n’est pas défini, aucune interface utilisateur n’est affichée.

MAPIFORM_EXACTMATCH

Seules les chaînes de classe de message qui correspondent exactement doivent être résolues.

lpszMessageClass

[in] Pointeur vers une chaîne qui nomme la classe de message du message à charger. Si NULL est passé dans le paramètre lpszMessageClass , la classe de message est déterminée à partir du message désigné par le paramètre pmsg .

ulMessageStatus

[in] Masque de bits d’indicateurs définis par le client ou par le fournisseur copiés à partir de la propriété PR_MSG_STATUS (PidTagMessageStatus) du message qui fournit des informations sur l’état du message. Le paramètre ulMessageStatus doit être défini si lpszMessageClass n’a pas la valeur NULL ; sinon, ulMessageStatus est ignoré.

ulMessageFlags

[in] Pointeur vers un masque de bits d’indicateurs copiés à partir de la propriété PR_MESSAGE_FLAGS (PidTagMessageFlags) du message qui indique l’état actuel du message. Le paramètre ulMessageFlags doit être défini si lpszMessageClass n’a pas la valeur NULL ; sinon, ulMessageFlags est ignoré.

pFolderFocus

[in] Pointeur vers le dossier qui contient directement le message. Le paramètre pFolderFocus peut avoir la valeur NULL si un tel dossier n’existe pas (par exemple, si le message est incorporé dans un autre message).

pMessageSite

[in] Pointeur vers le site de message du message.

pmsg

[in] Pointeur vers le message.

pViewContext

[in] Pointeur vers le contexte d’affichage du message. Le paramètre pViewContext peut être NULL.

Riid

[in] Identificateur d’interface (IID) de l’interface à utiliser pour l’objet de formulaire retourné. Le paramètre riid ne doit pas être NULL.

ppvObj

[out] Pointeur vers un pointeur vers l’interface retournée.

Valeur renvoyée

S_OK

L'appel a r�ussi et a renvoy� la valeur attendue ou les valeurs.

MAPI_E_NO_INTERFACE

Le formulaire ne prend pas en charge l’interface demandée.

MAPI_E_NOT_FOUND

La classe de message passée dans lpszMessageClass ne correspond à la classe de message pour aucun formulaire dans la bibliothèque de formulaires.

Remarques

Les visionneuses de formulaires appellent la méthode IMAPIFormMgr ::LoadForm pour ouvrir un formulaire pour un message existant. LoadForm ouvre l’objet de formulaire, charge le message dans l’objet formulaire, configure le contexte d’affichage approprié, si nécessaire, et retourne l’interface demandée pour l’objet formulaire.

Le paramètre pFolderFocus pointe vers le dossier qui contient le message. Si le message est incorporé dans un autre message, pFolderFocus doit avoir la valeur NULL.

Remarques pour les responsables de l’implémentation

Si NULL est transmis dans lpszMessageClass, l’implémentation obtient la classe de message, les status et les indicateurs du message à partir des propriétés PR_MESSAGE_CLASS (PidTagMessageClass), PR_MSG_STATUS et PR_MESSAGE_FLAGS du message. Si une chaîne de classe de message est fournie dans lpszMessageClass, l’implémentation doit utiliser les valeurs dans ulMessageStatus et ulMessageFlags.

Référence MFCMAPI

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

Fichier	Fonction	Commentaire
MAPIFormFunctions.cpp	OpenMessageNonModal	MFCMAPI utilise la méthode IMAPIFormMgr ::LoadForm pour charger un formulaire avant de l’afficher.

Voir aussi

Propriété canonique PidTagMessageClass
Propriété canonique PidTagMessageFlags
Propriété canonique PidTagMessageStatus
IMAPIFormMgr : IUnknown MFCMAPI en tant qu’exemple de code

Partager via