IMAPIProp::DeleteProps
S’applique à : Outlook 2013 | Outlook 2016
Supprime une ou plusieurs propriétés d’un objet .
HRESULT DeleteProps(
LPSPropTagArray lpPropTagArray,
LPSPropProblemArray FAR * lppProblems
);
Paramètres
lpPropTagArray
[in] Pointeur vers un tableau de balises de propriété qui indiquent les propriétés à supprimer. Le membre cValues de la structure SPropTagArray pointée par lpPropTagArray ne doit pas être égal à zéro et le paramètre lpPropTagArray lui-même ne doit pas être NULL.
lppProblems
[in, out] En entrée, pointeur vers un pointeur vers une structure SPropProblemArray ; sinon, NULL, ce qui indique qu’il n’y a pas besoin d’informations d’erreur. Si lppProblems est un pointeur valide en entrée, DeleteProps retourne des informations détaillées sur les erreurs de suppression d’une ou plusieurs propriétés.
Valeur renvoyée
S_OK
Les propriétés ont été supprimées avec succès.
MAPI_E_NO_ACCESS
L’appelant n’a pas les autorisations nécessaires pour supprimer des propriétés.
Remarques
La méthode IMAPIProp ::D eleteProps supprime une ou plusieurs propriétés de l’objet actuel.
Remarques pour les responsables de l’implémentation
Vous n’avez pas besoin d’autoriser la suppression des propriétés de tous les objets. Si l’objet n’est pas modifiable, retournez MAPI_E_NO_ACCESS à partir de la méthode DeleteProps .
Remarques pour les appelants
Vous n’avez pas besoin de définir le type de propriété pour chaque balise de propriété dans le tableau de balises de propriété vers lequel pointe le paramètre lpPropTagArray . Les types de propriétés sont ignorés ; seuls les identificateurs de propriété sont utilisés.
N’oubliez pas que certains objets n’autorisent pas la modification et que ces objets retournent MAPI_E_NO_ACCESS à partir de la méthode DeleteProps . D’autres objets permettent de supprimer certaines propriétés, mais pas d’autres. En cas de problème lors de la suppression d’une partie des propriétés, DeleteProps renvoie S_OK. Si vous avez passé un pointeur valide dans le paramètre lppProblems , DeleteProps définit le pointeur sur une structure SPropProblemArray qui contient des informations détaillées sur les problèmes liés à chaque propriété. Par exemple, si vous supprimez toutes les propriétés d’un message et qu’il y a un problème avec une ou plusieurs de ses pièces jointes, la structure SPropProblemArray contient une entrée pour la propriété PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments).
La structure pointée par lppProblems n’est valide que si DeleteProps renvoie S_OK. Si DeleteProps retourne une erreur, n’essayez pas d’utiliser la structure SPropProblemArray . Au lieu de cela, appelez la méthode IMAPIProp ::GetLastError de l’objet pour obtenir plus d’informations sur l’erreur.
Libérez la structure SPropProblemArray retournée en appelant la fonction MAPIFreeBuffer .
Référence MFCMAPI
Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.
| Fichier | Fonction | Commentaire |
|---|---|---|
| MAPIFunctions.cpp |
DeleteProperty |
MFCMAPI utilise la méthode IMAPIProp ::D eleteProps pour supprimer une propriété d’un objet. |