SetErrorInfo

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This function sets the error information object for the current thread of execution.


HRESULT SetErrorInfo( 
  DWORD dwReserved, 
  IErrorInfo* perrinfo 
); 

dwReserved

[in] Reserved for future use; must set to zero.

perrinfo

[in] Pointer to an error object that supports IErrorInfo.

Returns the HRESULT value S_OK if successful.

This function releases the existing error information object, if one exists, and sets the pointer to perrinfo.

Use this function after creating an error object that associates the object with the current thread of execution.

If the property or method that calls SetErrorInfo is called by DispInvoke, DispInvoke does the following:

  • Fills the EXCEPINFO parameter with the values specified in the error information object
  • Returns DISP_E_EXCEPTION when the property or method returns a failure value for DispInvoke.

Virtual function table (VTBL) binding controllers that do not use IDispatch::Invoke can get the error information object by using GetErrorInfo. This allows an object that supports a dual interface to use SetErrorInfo, regardless of whether the client uses VTBL binding or IDispatch.

Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.

The following example code shows how to use the SetErrorInfo function.

To use this function correctly, make sure that you have an EXCEPINFO structure that is populated with information about the exception that occurred.

ICreateErrorInfo *pcerrinfo;
  IErrorInfo *perrinfo;
  HRESULT hr;
hr = CreateErrorInfo(&pcerrinfo);
hr = pcerrinfo->SetGUID(IID_IHello);
hr = pcerrinfo->SetSource(m_excepinfo.bstrSource);
hr = pcerrinfo->SetDescription(m_excepinfo.bstrDescription);
hr = pcerrinfo->SetHelpFile(NULL);
hr = pcerrinfo->SetHelpContext(0);

hr = pcerrinfo->QueryInterface(IID_IErrorInfo, (LPVOID FAR*) &perrinfo);
if (SUCCEEDED(hr))
  {
    SetErrorInfo(0, perrinfo);
    perrinfo->Release();
  }
pcerrinfo->Release();

Headeroleauto.h
Libraryoleaut32.lib
Windows Embedded CEWindows CE 1.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show: