IMAPISession::ShowForm
S’applique à : Outlook 2013 | Outlook 2016
Affiche un formulaire.
HRESULT ShowForm(
ULONG_PTR ulUIParam,
LPMDB lpMsgStore,
LPMAPIFOLDER lpParentFolder,
LPCIID lpInterface,
ULONG ulMessageToken,
LPMESSAGE lpMessageSent,
ULONG ulFlags,
ULONG ulMessageStatus,
ULONG ulMessageFlags,
ULONG ulAccess,
LPSTR lpszMessageClass
);
Paramètres
ulUIParam
[in] Handle de la fenêtre parente du formulaire.
lpMsgStore
[in] Pointeur vers la banque de messages qui contient le dossier vers lequel pointe le paramètre lpParentFolder .
lpParentFolder
[in] Pointeur vers le dossier dans lequel le message associé au paramètre ulMessageToken a été créé.
lpInterface
[in] Pointeur vers l’identificateur d’interface (IID) qui représente l’interface à utiliser pour accéder au message affiché dans le formulaire. Le paramètre lpInterface doit être NULL ou IID_IMessage. La transmission de la valeur NULL entraîne l’utilisation de l’interface standard, IMessage.
ulMessageToken
[in] Jeton associé au message à afficher dans le formulaire. Le paramètre ulMessageToken doit être défini sur le contenu du paramètre lpulMessageToken de l’appel précédent à IMAPISession ::P repareForm.
lpMessageSent
[in] Réservés au; doit avoir la valeur NULL.
ulFlags
[in] Masque de bits d’indicateurs qui contrôle comment et si le message est enregistré. Les indicateurs suivants peuvent être définis :
MAPI_NEW_MESSAGE
Le message n’a jamais été enregistré (autrement dit, sa méthode IMAPIProp ::SaveChanges n’a jamais été appelée).
MAPI_POST_MESSAGE
Le message doit être enregistré dans son dossier parent. Le message n’est pas traité pour l’envoi, mais il est publié dans le dossier à la place. Si cet indicateur n’est pas défini, le message est copié dans la boîte d’envoi et traité pour l’envoi.
ulMessageStatus
[in] Masque de bits d’indicateurs copiés à partir de la propriété PR_MSG_STATUS (PidTagMessageStatus) du message associé au jeton dans le paramètre ulMessageToken . Les indicateurs fournissent des informations sur l’état du message.
ulMessageFlags
[in] Masque de bits d’indicateurs copiés à partir de la propriété PR_MESSAGE_FLAGS (PidTagMessageFlags) du message associé au jeton dans le paramètre ulMessageToken . Ces indicateurs fournissent des informations supplémentaires sur l’état du message.
ulAccess
[in] Indicateur qui indique le niveau d’autorisation du message affiché dans le formulaire. Ces informations sont copiées à partir de la propriété PR_ACCESS (PidTagAccess) du message associé au jeton dans le paramètre ulMessageToken .
lpszMessageClass
[in] Pointeur vers la classe de message du message affiché dans le formulaire, copié à partir de la propriété PR_MESSAGE_CLASS (PidTagMessageClass) du message associé au jeton dans le paramètre ulMessageToken .
Valeur renvoyée
S_OK
Le formulaire s’est correctement affiché.
MAPI_E_USER_CANCEL
L’utilisateur a annulé l’opération, généralement en cliquant sur le bouton Annuler dans une boîte de dialogue.
Remarques
La méthode IMAPISession ::ShowForm affiche un formulaire de message qui a été préparé par la méthode IMAPISession ::P repareForm .
Remarques pour les appelants
Vous ne devez avoir qu’une seule référence au message passé dans le paramètre lpMessage de la méthode PrepareForm.
N’oubliez pas que les implémentations de formulaire peuvent retourner des valeurs d’erreur autres que celles documentées par MAPI. Si vous pouvez utiliser ces valeurs d’erreur pour déterminer plus précisément la condition d’erreur, procédez comme suit. Sinon, gérez ces erreurs comme vous le feriez pour MAPI_E_CALL_FAILED.
Référence MFCMAPI
Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.
| Fichier | Fonction | Commentaire |
|---|---|---|
| MAPIFormFunctions.cpp |
OpenMessageModal |
MFCMAPI utilise la méthode IMAPISession ::ShowForm , ainsi que la méthode PrepareForm , pour afficher un message dans un formulaire modal. |