IMSLogon::GetLastError

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Returns a MAPIERROR structure that contains information about the last error that occurred for the message store object.

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

Parameters

  • hResult
    [in] An HRESULT data type that contains the error value generated in the previous method call for the message store object.

  • ulFlags
    [in] A bitmask of flags that controls the type of strings returned. 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] A pointer to a pointer to the returned MAPIERROR structure that contains version, component, and context information for the error. The lppMAPIError parameter can be set to NULL if there is no MAPIERROR to return.

Return Value

  • 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 supports only Unicode.

Remarks

Use the IMSLogon::GetLastError method to retrieve information to display in a message to the user regarding the last error returned from a method call for the message store object.

To release all the memory allocated by MAPI for the returned MAPIERROR structure, client applications need to call only the MAPIFreeBuffer function.

The return value from GetLastError must be S_OK for an application to use the MAPIERROR. Even if the return value is S_OK, a MAPIERROR might not be returned. If the implementation cannot determine what the last error was, or if a MAPIERROR is not available for that error, GetLastError returns a pointer to NULL in lppMAPIError instead.

See Also

Reference

MAPIERROR

MAPIFreeBuffer

IMSLogon : IUnknown