MAPIERROR
Aplica-se a: Outlook 2013 | Outlook 2016
Fornece informações detalhadas sobre um erro, normalmente gerado pelo sistema operacional, MAPI ou um provedor de serviços.
| Propriedade | Valor |
|---|---|
| Arquivo de cabeçalho: |
Mapidefs.h |
typedef struct _MAPIERROR
{
ULONG ulVersion;
LPSTR lpszError;
LPSTR lpszComponent;
ULONG ulLowLevelError;
ULONG ulContext;
} MAPIERROR, FAR * LPMAPIERROR;
Members
ulVersion
Número da versão da estrutura. O membro ulVersion é usado para expansão futura e deve ser definido como MAPI_ERROR_VERSION, que atualmente é definido como zero.
lpszError
Ponteiro para uma cadeia de caracteres que descreve o erro. Essa cadeia de caracteres estará no formato Unicode se o parâmetro ulFlags para o método no qual essa estrutura é usada estiver definida como MAPI_UNICODE.
lpszComponent
Ponteiro para uma cadeia de caracteres que descreve o componente que gerou o erro. Essa cadeia de caracteres estará no formato Unicode se o parâmetro ulFlags para o método no qual essa estrutura é usada estiver definida como MAPI_UNICODE.
ulLowLevelError
Valor de erro de baixo nível que é usado somente quando o erro a ser retornado é de baixo nível.
ulContext
Valor que representa o local no componente apontado pelo membro lpszComponent que identifica onde o erro ocorreu.
Comentários
A estrutura MAPIERROR é usada para descrever informações de erro. Clientes e provedores de serviços passam um ponteiro para uma estrutura MAPIERROR no parâmetro lppMAPIError do método IMAPIProp::GetLastError . GetLastError retorna informações sobre o erro anterior que ocorreu a um objeto. Os chamadores do GetLastError liberam a memória da estrutura MAPIERROR chamando MAPIFreeBuffer.
O membro lpszComponent pode ser usado para mapear o arquivo de ajuda do componente, se houver um. Os provedores de serviço devem limitar o tamanho da cadeia de caracteres do componente a 30 caracteres para que ela possa ser exibida facilmente em uma caixa de diálogo. O membro ulContext também pode ser usado para se referir a um tópico de ajuda online para erros comuns.
Como os provedores de serviços não são necessários para fornecer informações detalhadas de erro, os clientes não devem esperar nenhum dos membros da estrutura MAPIERROR que são retornados para conter dados válidos. No entanto, no mínimo, o MAPI recomenda fortemente que os provedores especifiquem informações nos membros lpszComponent e ulContext .
Para obter mais informações sobre o tratamento de erros no MAPI, consulte Tratamento de Erros.