IMsgServiceAdmin::GetLastError

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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

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

Parameters

  • hResult
    [in] An HRESULT data type that contains the error value generated by 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. The lppMAPIError 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
    The MAPI_UNICODE flag was set and the message service administration object does not support Unicode.

Remarks

The IMsgServiceAdmin::GetLastError method retrieves information about the last error that was returned by an IMsgServiceAdmin method call. Clients can provide their users with detailed information about the error by including this information in a dialog box.

Notes to Callers

You can make use of the MAPIERROR structure, if MAPI supplies one, pointed to by the lppMAPIError parameter 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, GetLastError returns a pointer to NULL in lppMAPIError instead.

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

See Also

Reference

MAPIERROR

MAPIFreeBuffer

IMsgServiceAdmin : IUnknown