IMAPIFormFactory::GetLastError

  • Article

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Returns a MAPIERROR structure that contains information about the previous error occurring to the form factory 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.

  • 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. This parameter can be set to NULL if there is no MAPIERROR structure 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 GetLastError does not support Unicode, or MAPI_UNICODE was not set and GetLastError supports only Unicode.

Remarks

The IMAPIFormFactory::GetLastError method supplies information about a prior method call that failed. 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.

See Also

Reference

MAPIERROR

MAPIFreeBuffer

IMAPIFormFactory : IUnknown