errorinfo.c

Go to the documentation of this file.

/*
 * ErrorInfo API
 *
 * Copyright 2000 Patrik Stridvall, Juergen Schmied
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 *
 * NOTES:
 *
 * The errorinfo is a per-thread object. The reference is stored in the
 * TEB at offset 0xf80.
 */
 
#include <stdarg.h>
#include <string.h>
 
#define COBJMACROS
 
#include "windef.h"
#include "winbase.h"
#include "objbase.h"
#include "oleauto.h"
#include "winerror.h"
 
#include "compobj_private.h"
 
#include "wine/debug.h"
 
WINE_DEFAULT_DEBUG_CHANNEL(ole);
 
static inline WCHAR *heap_strdupW(const WCHAR *str)
{
    WCHAR *ret = NULL;
 
    if(str) {
        size_t size;
 
        size = (lstrlenW(str)+1)*sizeof(WCHAR);
        ret = heap_alloc(size);
        if(ret)
            memcpy(ret, str, size);
    }
 
    return ret;
}
 
typedef struct ErrorInfoImpl
{
    IErrorInfo IErrorInfo_iface;
    ICreateErrorInfo ICreateErrorInfo_iface;
    ISupportErrorInfo ISupportErrorInfo_iface;
    LONG ref;
 
    GUID m_Guid;
    WCHAR *source;
    WCHAR *description;
    WCHAR *help_file;
    DWORD m_dwHelpContext;
} ErrorInfoImpl;
 
static inline ErrorInfoImpl *impl_from_IErrorInfo( IErrorInfo *iface )
{
    return CONTAINING_RECORD(iface, ErrorInfoImpl, IErrorInfo_iface);
}
 
static inline ErrorInfoImpl *impl_from_ICreateErrorInfo( ICreateErrorInfo *iface )
{
    return CONTAINING_RECORD(iface, ErrorInfoImpl, ICreateErrorInfo_iface);
}
 
static inline ErrorInfoImpl *impl_from_ISupportErrorInfo( ISupportErrorInfo *iface )
{
    return CONTAINING_RECORD(iface, ErrorInfoImpl, ISupportErrorInfo_iface);
}
 
static HRESULT WINAPI IErrorInfoImpl_QueryInterface(
    IErrorInfo* iface,
    REFIID     riid,
    void**     ppvoid)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
    TRACE("(%p)->(%s,%p)\n", This, debugstr_guid(riid),ppvoid);
 
    *ppvoid = NULL;
 
    if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_IErrorInfo))
    {
      *ppvoid = &This->IErrorInfo_iface;
    }
    else if(IsEqualIID(riid, &IID_ICreateErrorInfo))
    {
      *ppvoid = &This->ICreateErrorInfo_iface;
    }
    else if(IsEqualIID(riid, &IID_ISupportErrorInfo))
    {
      *ppvoid = &This->ISupportErrorInfo_iface;
    }
 
    if(*ppvoid)
    {
      IUnknown_AddRef( (IUnknown*)*ppvoid );
      TRACE("-- Interface: (%p)->(%p)\n",ppvoid,*ppvoid);
      return S_OK;
    }
    TRACE("-- Interface: E_NOINTERFACE\n");
    return E_NOINTERFACE;
}
 
static ULONG WINAPI IErrorInfoImpl_AddRef(
    IErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
    TRACE("(%p)->(count=%u)\n",This,This->ref);
    return InterlockedIncrement(&This->ref);
}
 
static ULONG WINAPI IErrorInfoImpl_Release(
    IErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
        ULONG ref = InterlockedDecrement(&This->ref);
 
    TRACE("(%p)->(count=%u)\n",This,ref+1);
 
    if (!ref)
    {
      TRACE("-- destroying IErrorInfo(%p)\n",This);
 
          heap_free(This->source);
          heap_free(This->description);
          heap_free(This->help_file);
          heap_free(This);
    }
    return ref;
}
 
static HRESULT WINAPI IErrorInfoImpl_GetGUID(
    IErrorInfo* iface,
    GUID * pGUID)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
    TRACE("(%p)->(count=%u)\n",This,This->ref);
    if(!pGUID )return E_INVALIDARG;
    *pGUID = This->m_Guid;
    return S_OK;
}
 
static HRESULT WINAPI IErrorInfoImpl_GetSource(
    IErrorInfo* iface,
    BSTR *pBstrSource)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
    TRACE("(%p)->(pBstrSource=%p)\n",This,pBstrSource);
    if (pBstrSource == NULL)
        return E_INVALIDARG;
    *pBstrSource = SysAllocString(This->source);
    return S_OK;
}
 
static HRESULT WINAPI IErrorInfoImpl_GetDescription(
    IErrorInfo* iface,
    BSTR *pBstrDescription)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 
    TRACE("(%p)->(pBstrDescription=%p)\n",This,pBstrDescription);
    if (pBstrDescription == NULL)
        return E_INVALIDARG;
    *pBstrDescription = SysAllocString(This->description);
 
    return S_OK;
}
 
static HRESULT WINAPI IErrorInfoImpl_GetHelpFile(
    IErrorInfo* iface,
    BSTR *pBstrHelpFile)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 
    TRACE("(%p)->(pBstrHelpFile=%p)\n",This, pBstrHelpFile);
    if (pBstrHelpFile == NULL)
        return E_INVALIDARG;
    *pBstrHelpFile = SysAllocString(This->help_file);
 
    return S_OK;
}
 
static HRESULT WINAPI IErrorInfoImpl_GetHelpContext(
    IErrorInfo* iface,
    DWORD *pdwHelpContext)
{
    ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
    TRACE("(%p)->(pdwHelpContext=%p)\n",This, pdwHelpContext);
    if (pdwHelpContext == NULL)
        return E_INVALIDARG;
    *pdwHelpContext = This->m_dwHelpContext;
 
    return S_OK;
}
 
static const IErrorInfoVtbl ErrorInfoVtbl =
{
  IErrorInfoImpl_QueryInterface,
  IErrorInfoImpl_AddRef,
  IErrorInfoImpl_Release,
  IErrorInfoImpl_GetGUID,
  IErrorInfoImpl_GetSource,
  IErrorInfoImpl_GetDescription,
  IErrorInfoImpl_GetHelpFile,
  IErrorInfoImpl_GetHelpContext
};
 
 
static HRESULT WINAPI ICreateErrorInfoImpl_QueryInterface(
    ICreateErrorInfo* iface,
    REFIID     riid,
    VOID**     ppvoid)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    return IErrorInfo_QueryInterface(&This->IErrorInfo_iface, riid, ppvoid);
}
 
static ULONG WINAPI ICreateErrorInfoImpl_AddRef(
    ICreateErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    return IErrorInfo_AddRef(&This->IErrorInfo_iface);
}
 
static ULONG WINAPI ICreateErrorInfoImpl_Release(
    ICreateErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    return IErrorInfo_Release(&This->IErrorInfo_iface);
}
 
 
static HRESULT WINAPI ICreateErrorInfoImpl_SetGUID(
    ICreateErrorInfo* iface,
    REFGUID rguid)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    TRACE("(%p)->(%s)\n", This, debugstr_guid(rguid));
    This->m_Guid = *rguid;
    return S_OK;
}
 
static HRESULT WINAPI ICreateErrorInfoImpl_SetSource(
    ICreateErrorInfo* iface,
    LPOLESTR szSource)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    TRACE("(%p): %s\n",This, debugstr_w(szSource));
 
    heap_free(This->source);
    This->source = heap_strdupW(szSource);
 
    return S_OK;
}
 
static HRESULT WINAPI ICreateErrorInfoImpl_SetDescription(
    ICreateErrorInfo* iface,
    LPOLESTR szDescription)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    TRACE("(%p): %s\n",This, debugstr_w(szDescription));
 
    heap_free(This->description);
    This->description = heap_strdupW(szDescription);
    return S_OK;
}
 
static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpFile(
    ICreateErrorInfo* iface,
    LPOLESTR szHelpFile)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    TRACE("(%p,%s)\n",This,debugstr_w(szHelpFile));
    heap_free(This->help_file);
    This->help_file = heap_strdupW(szHelpFile);
    return S_OK;
}
 
static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpContext(
    ICreateErrorInfo* iface,
    DWORD dwHelpContext)
{
    ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
    TRACE("(%p,%d)\n",This,dwHelpContext);
    This->m_dwHelpContext = dwHelpContext;
    return S_OK;
}
 
static const ICreateErrorInfoVtbl CreateErrorInfoVtbl =
{
  ICreateErrorInfoImpl_QueryInterface,
  ICreateErrorInfoImpl_AddRef,
  ICreateErrorInfoImpl_Release,
  ICreateErrorInfoImpl_SetGUID,
  ICreateErrorInfoImpl_SetSource,
  ICreateErrorInfoImpl_SetDescription,
  ICreateErrorInfoImpl_SetHelpFile,
  ICreateErrorInfoImpl_SetHelpContext
};
 
static HRESULT WINAPI ISupportErrorInfoImpl_QueryInterface(
    ISupportErrorInfo* iface,
    REFIID     riid,
    VOID**     ppvoid)
{
    ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
    return IErrorInfo_QueryInterface(&This->IErrorInfo_iface, riid, ppvoid);
}
 
static ULONG WINAPI ISupportErrorInfoImpl_AddRef(ISupportErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
    return IErrorInfo_AddRef(&This->IErrorInfo_iface);
}
 
static ULONG WINAPI ISupportErrorInfoImpl_Release(ISupportErrorInfo* iface)
{
    ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
    return IErrorInfo_Release(&This->IErrorInfo_iface);
}
 
static HRESULT WINAPI ISupportErrorInfoImpl_InterfaceSupportsErrorInfo(
    ISupportErrorInfo* iface,
    REFIID riid)
{
    ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
    TRACE("(%p)->(%s)\n", This, debugstr_guid(riid));
    return (IsEqualIID(riid, &This->m_Guid)) ? S_OK : S_FALSE;
}
 
static const ISupportErrorInfoVtbl SupportErrorInfoVtbl =
{
  ISupportErrorInfoImpl_QueryInterface,
  ISupportErrorInfoImpl_AddRef,
  ISupportErrorInfoImpl_Release,
  ISupportErrorInfoImpl_InterfaceSupportsErrorInfo
};
 
static IErrorInfo* IErrorInfoImpl_Constructor(void)
{
    ErrorInfoImpl *This = heap_alloc(sizeof(ErrorInfoImpl));
 
    if (!This) return NULL;
 
    This->IErrorInfo_iface.lpVtbl = &ErrorInfoVtbl;
    This->ICreateErrorInfo_iface.lpVtbl = &CreateErrorInfoVtbl;
    This->ISupportErrorInfo_iface.lpVtbl = &SupportErrorInfoVtbl;
    This->ref = 1;
    This->source = NULL;
    This->description = NULL;
    This->help_file = NULL;
    This->m_dwHelpContext = 0;
 
    return &This->IErrorInfo_iface;
}
 
/***********************************************************************
 *      CreateErrorInfo (OLE32.@)
 *
 * Creates an object used to set details for an error info object.
 *
 * PARAMS
 *  pperrinfo [O]. Address where error info creation object will be stored.
 *
 * RETURNS
 *  Success: S_OK.
 *  Failure: HRESULT code.
 */
HRESULT WINAPI CreateErrorInfo(ICreateErrorInfo **pperrinfo)
{
    IErrorInfo * pei;
    HRESULT res;
    TRACE("(%p)\n", pperrinfo);
    if(! pperrinfo ) return E_INVALIDARG;
    if(!(pei=IErrorInfoImpl_Constructor()))return E_OUTOFMEMORY;
 
    res = IErrorInfo_QueryInterface(pei, &IID_ICreateErrorInfo, (LPVOID*)pperrinfo);
    IErrorInfo_Release(pei);
    return res;
}
 
/***********************************************************************
 *      GetErrorInfo (OLE32.@)
 *
 * Retrieves the error information object for the current thread.
 *
 * PARAMS
 *  dwReserved [I]. Reserved. Must be zero.
 *  pperrinfo  [O]. Address where error information object will be stored on return.
 *
 * RETURNS
 *  Success: S_OK if an error information object was set for the current thread.
 *           S_FALSE if otherwise.
 *  Failure: E_INVALIDARG if dwReserved is not zero.
 *
 * NOTES
 *  This function causes the current error info object for the thread to be
 *  cleared if one was set beforehand.
 */
HRESULT WINAPI GetErrorInfo(ULONG dwReserved, IErrorInfo **pperrinfo)
{
    TRACE("(%d, %p, %p)\n", dwReserved, pperrinfo, COM_CurrentInfo()->errorinfo);
 
    if (dwReserved)
    {
        ERR("dwReserved (0x%x) != 0\n", dwReserved);
        return E_INVALIDARG;
    }
 
    if(!pperrinfo) return E_INVALIDARG;
 
    if (!COM_CurrentInfo()->errorinfo)
    {
       *pperrinfo = NULL;
       return S_FALSE;
    }
 
    *pperrinfo = COM_CurrentInfo()->errorinfo;
        
    /* clear thread error state */
    COM_CurrentInfo()->errorinfo = NULL;
    return S_OK;
}
 
/***********************************************************************
 *      SetErrorInfo (OLE32.@)
 *
 * Sets the error information object for the current thread.
 *
 * PARAMS
 *  dwReserved [I] Reserved. Must be zero.
 *  perrinfo   [I] Error info object.
 *
 * RETURNS
 *  Success: S_OK.
 *  Failure: E_INVALIDARG if dwReserved is not zero.
 */
HRESULT WINAPI SetErrorInfo(ULONG dwReserved, IErrorInfo *perrinfo)
{
    IErrorInfo * pei;
 
    TRACE("(%d, %p)\n", dwReserved, perrinfo);
 
    if (dwReserved)
    {
        ERR("dwReserved (0x%x) != 0\n", dwReserved);
        return E_INVALIDARG;
    }
 
    /* release old errorinfo */
    pei = COM_CurrentInfo()->errorinfo;
    if (pei) IErrorInfo_Release(pei);
 
    /* set to new value */
    COM_CurrentInfo()->errorinfo = perrinfo;
    if (perrinfo) IErrorInfo_AddRef(perrinfo);
        
    return S_OK;
}