MAPIERROR
S’applique à : Outlook 2013 | Outlook 2016
Fournit des informations détaillées sur une erreur, généralement générée par le système d’exploitation, MAPI ou un fournisseur de services.
| Propriété | Valeur |
|---|---|
| Fichier d’en-tête : |
Mapidefs.h |
typedef struct _MAPIERROR
{
ULONG ulVersion;
LPSTR lpszError;
LPSTR lpszComponent;
ULONG ulLowLevelError;
ULONG ulContext;
} MAPIERROR, FAR * LPMAPIERROR;
Members
ulVersion
Numéro de version de la structure. Le membre ulVersion est utilisé pour l’extension future et doit être défini sur MAPI_ERROR_VERSION, qui est actuellement défini sur zéro.
lpszError
Pointeur vers une chaîne qui décrit l’erreur. Cette chaîne sera au format Unicode si le paramètre ulFlags de la méthode dans laquelle cette structure est utilisée est défini sur MAPI_UNICODE.
lpszComponent
Pointeur vers une chaîne qui décrit le composant qui a généré l’erreur. Cette chaîne sera au format Unicode si le paramètre ulFlags de la méthode dans laquelle cette structure est utilisée est défini sur MAPI_UNICODE.
ulLowLevelError
Valeur d’erreur de bas niveau utilisée uniquement lorsque l’erreur à retourner est de bas niveau.
ulContext
Valeur qui représente l’emplacement dans le composant vers lequel pointe le membre lpszComponent qui identifie où l’erreur s’est produite.
Remarques
La structure MAPIERROR est utilisée pour décrire les informations d’erreur. Les clients et les fournisseurs de services passent un pointeur vers une structure MAPIERROR dans le paramètre lppMAPIError de la méthode IMAPIProp ::GetLastError . GetLastError retourne des informations sur l’erreur précédente qui s’est produite sur un objet. Les appelants de GetLastError libèrent la mémoire de la structure MAPIERROR en appelant MAPIFreeBuffer.
Le membre lpszComponent peut être utilisé pour mapper le fichier d’aide du composant, s’il en existe un. Les fournisseurs de services doivent limiter la taille de la chaîne de composant à 30 caractères afin qu’elle puisse facilement être affichée dans une boîte de dialogue. Le membre ulContext peut également être utilisé pour faire référence à une rubrique d’aide en ligne pour connaître les erreurs courantes.
Étant donné que les fournisseurs de services ne sont pas tenus de fournir des informations d’erreur détaillées, les clients ne doivent pas s’attendre à ce que les membres de la structure MAPIERROR retournés contiennent des données valides. Toutefois, MAPI recommande vivement aux fournisseurs de spécifier des informations dans les membres lpszComponent et ulContext .
Pour plus d’informations sur la gestion des erreurs dans MAPI, consultez Gestion des erreurs.