IMAPITable::GetLastError

The IMAPITable::GetLastError method returns a MAPIERROR structure containing information about the previous error on the table.

Quick Info

See IMAPITable : IUnknown.

HRESULT GetLastError(
  HRESULT hResult,                
  ULONG ulFlags,                  
  LPMAPIERROR FAR * lppMAPIError  
);

Parameters

hResult

[in] HRESULT data type containing the error value generated in the previous method call.

ulFlags

[in] Bitmask of flags that controls the type of the returned strings. The following flag can be set:

MAPI_UNICODE: The strings in the MAPIERROR structure returned in the lppMAPIError parameter are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.

lppMAPIError

[out] Pointer to a pointer to the returned MAPIERROR structure containing version, component, and context information for the error. The lppMAPIError parameter can be set to NULL if a MAPIERROR structure with appropriate information cannot be provided.

Return Values

S_OK: The call succeeded and has returned the expected value or values.
MAPI_E_BAD_CHARWIDTH: Either the MAPI_UNICODE flag was set and the implementation does not support Unicode, or MAPI_UNICODE was not set and the implementation only supports Unicode.

Remarks

The IMAPITable::GetLastError method returns detailed information, if available, about a prior method call that failed. This information can be displayed in a message or a dialog box.

Notes to Callers

Call GetLastError whenever you need to display information about an error to the user.

You can make use of the MAPIERROR structure pointed to by the lppMAPIError parameter — if the table object supplies one — only if GetLastError returns S_OK. Sometimes the table implementation cannot determine what the last error was or has nothing more to report about the error. In this situation, you'll find a pointer to NULL in lppMAPIError instead.

To release all the memory allocated for the MAPIERROR structure, call the MAPIFreeBuffer function.

For more information about the GetLastError method, see Using Extended Errors.