IMAPISupport::GetLastError

Platform SDK: MAPI

IMAPISupport::GetLastError

The IMAPISupport::GetLastError method returns a MAPIERROR structure containing information about the previous support object error.

Quick Info

See IMAPISupport : 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 for the support object.

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 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 error 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 MAPI does not support Unicode, or MAPI_UNICODE was not set and MAPI only supports Unicode.

Remarks

The IMAPISupport::GetLastError method is implemented for all support objects. Callers can provide their users with detailed information about the error by including the data from the MAPIERROR structure in a dialog box.

Notes to Callers

You can make use of the MAPIERROR structure pointed to by the lppMAPIError parameter, if MAPI supplies one, only if GetLastError returns S_OK. Sometimes MAPI cannot determine what the last error was or has nothing more to report about the error. In this situation, a pointer to NULL is returned in lppMAPIError instead.

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

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