SetErrorInfo

Article
06/30/2006

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

HRESULT SetErrorInfo( 
  DWORD dwReserved, 
  IErrorInfo* perrinfo 
);

Parameters

dwReserved
[in] Reserved for future use; must set to zero.
perrinfo
[in] Pointer to an error object.

Return Values

The function returns the HRESULT S_OK if it is successful.

Remarks

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, then DispInvoke will fill the EXCEPINFO parameter with the values specified in the error information object. DispInvoke will return DISP_E_EXCEPTION when the property or method returns a failure return 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.

Example

ICreateErrorInfo *pcerrinfo;
  IErrorInfo *perrinfo;
  HRESULT hr;

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

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.

Share via