MAPIERROR
适用于:Outlook 2013 | Outlook 2016
提供有关错误的详细信息,通常由操作系统、MAPI 或服务提供商生成。
属性 | 值 |
---|---|
标头文件: |
Mapidefs.h |
typedef struct _MAPIERROR
{
ULONG ulVersion;
LPSTR lpszError;
LPSTR lpszComponent;
ULONG ulLowLevelError;
ULONG ulContext;
} MAPIERROR, FAR * LPMAPIERROR;
Members
ulVersion
结构的版本号。 ulVersion 成员用于将来的扩展,应设置为 MAPI_ERROR_VERSION,当前定义为零。
lpszError
指向描述错误的字符串的指针。 如果使用此结构的方法的 ulFlags 参数设置为 MAPI_UNICODE,则此字符串将采用 Unicode 格式。
lpszComponent
指向描述生成错误的组件的字符串的指针。 如果使用此结构的方法的 ulFlags 参数设置为 MAPI_UNICODE,则此字符串将采用 Unicode 格式。
ulLowLevelError
仅当要返回的错误为低级别时使用的低级别错误值。
ulContext
值,表示 lpszComponent 成员指向的组件中的位置,该成员标识错误发生的位置。
备注
MAPIERROR 结构用于描述错误信息。 客户端和服务提供程序在 IMAPIProp::GetLastError 方法的 lppMAPIError 参数中传递指向 MAPIERROR 结构的指针。 GetLastError 返回有关对象上发生的上一个错误的信息。 GetLastError 的调用方通过调用 MAPIFreeBuffer 释放 MAPIERROR 结构的内存。
lpszComponent 成员可用于映射组件的帮助文件(如果存在)。 服务提供商应将组件字符串的大小限制为 30 个字符,以便可以轻松地显示在对话框中。 ulContext 成员还可用于引用联机帮助主题,了解常见错误。
由于不需要服务提供商提供详细的错误信息,因此客户端不应期望返回的任何 MAPIERROR 结构成员包含有效数据。 但是,至少 MAPI 强烈建议提供程序在 lpszComponent 和 ulContext 成员中指定信息。
有关 MAPI 中的错误处理的详细信息,请参阅 错误处理。