IProfAdmin::GetLastError

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Returns a MAPIERROR structure that contains information about the previous error that occurred to a profile administration 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 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
    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

The IProfAdmin::GetLastError method retrieves information about the last error returned from a method call for the profile administration object.

Notes to Callers

You can use 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, a pointer to NULL is returned in lppMAPIError.

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

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

See Also

Reference

MAPIERROR

MAPIFreeBuffer

IProfAdmin : IUnknown