wine/dlls/ole32/errorinfo.c

572 lines
14 KiB
C
Raw Normal View History

/*
* ErrorInfo API
*
2000-08-03 04:34:59 +00:00
* 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:
*
2002-05-31 23:06:46 +00:00
* 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 "wine/unicode.h"
#include "compobj_private.h"
#include "wine/debug.h"
WINE_DEFAULT_DEBUG_CHANNEL(ole);
/* this code is from SysAllocStringLen (ole2disp.c in oleaut32) */
static BSTR ERRORINFO_SysAllocString(const OLECHAR* in)
{
DWORD bufferSize;
DWORD* newBuffer;
WCHAR* stringBuffer;
DWORD len;
2002-05-31 23:06:46 +00:00
if (in == NULL)
return NULL;
/*
2006-10-15 15:05:01 +00:00
* Find the length of the buffer passed-in, in bytes.
*/
len = strlenW(in);
bufferSize = len * sizeof (WCHAR);
/*
* Allocate a new buffer to hold the string.
2004-01-06 22:08:33 +00:00
* don't forget to keep an empty spot at the beginning of the
* buffer for the character count and an extra character at the
* end for the '\0'.
*/
newBuffer = HeapAlloc(GetProcessHeap(), 0,
bufferSize + sizeof(WCHAR) + sizeof(DWORD));
/*
* If the memory allocation failed, return a null pointer.
*/
if (newBuffer==0)
return 0;
/*
* Copy the length of the string in the placeholder.
*/
*newBuffer = bufferSize;
/*
* Skip the byte count.
*/
newBuffer++;
/*
* Copy the information in the buffer. It is not possible to pass
* a NULL pointer here.
*/
memcpy(newBuffer, in, bufferSize);
/*
* Make sure that there is a nul character at the end of the
* string.
*/
stringBuffer = (WCHAR*)newBuffer;
stringBuffer[len] = 0;
return stringBuffer;
}
/* this code is from SysFreeString (ole2disp.c in oleaut32)*/
static VOID ERRORINFO_SysFreeString(BSTR in)
{
DWORD* bufferPointer;
2002-05-31 23:06:46 +00:00
/* NULL is a valid parameter */
if(!in) return;
/*
* We have to be careful when we free a BSTR pointer, it points to
* the beginning of the string but it skips the byte count contained
* before the string.
*/
bufferPointer = (DWORD*)in;
bufferPointer--;
/*
* Free the memory from it's "real" origin.
*/
HeapFree(GetProcessHeap(), 0, bufferPointer);
}
2000-08-03 04:34:59 +00:00
typedef struct ErrorInfoImpl
{
const IErrorInfoVtbl *lpvtei;
const ICreateErrorInfoVtbl *lpvtcei;
const ISupportErrorInfoVtbl *lpvtsei;
2005-07-05 11:02:54 +00:00
LONG ref;
2002-05-31 23:06:46 +00:00
GUID m_Guid;
BSTR bstrSource;
BSTR bstrDescription;
BSTR bstrHelpFile;
DWORD m_dwHelpContext;
2000-08-03 04:34:59 +00:00
} ErrorInfoImpl;
static const IErrorInfoVtbl IErrorInfoImpl_VTable;
static const ICreateErrorInfoVtbl ICreateErrorInfoImpl_VTable;
static const ISupportErrorInfoVtbl ISupportErrorInfoImpl_VTable;
2000-08-03 04:34:59 +00:00
/*
2005-03-23 13:15:18 +00:00
converts an object pointer to This
2000-08-03 04:34:59 +00:00
*/
static inline ErrorInfoImpl *impl_from_IErrorInfo( IErrorInfo *iface )
{
return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtei));
}
static inline ErrorInfoImpl *impl_from_ICreateErrorInfo( ICreateErrorInfo *iface )
{
return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtcei));
}
static inline ErrorInfoImpl *impl_from_ISupportErrorInfo( ISupportErrorInfo *iface )
{
return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtsei));
}
2000-08-03 04:34:59 +00:00
/*
2005-03-23 13:15:18 +00:00
converts This to an object pointer
2000-08-03 04:34:59 +00:00
*/
#define _IErrorInfo_(This) ((IErrorInfo*)&(This)->lpvtei)
#define _ICreateErrorInfo_(This) (&(This)->lpvtcei)
#define _ISupportErrorInfo_(This) (&(This)->lpvtsei)
2000-08-03 04:34:59 +00:00
2007-01-18 21:50:56 +00:00
static IErrorInfo * IErrorInfoImpl_Constructor(void)
2000-08-03 04:34:59 +00:00
{
ErrorInfoImpl * ei = HeapAlloc(GetProcessHeap(), 0, sizeof(ErrorInfoImpl));
if (ei)
{
ei->lpvtei = &IErrorInfoImpl_VTable;
ei->lpvtcei = &ICreateErrorInfoImpl_VTable;
ei->lpvtsei = &ISupportErrorInfoImpl_VTable;
ei->ref = 1;
ei->bstrSource = NULL;
ei->bstrDescription = NULL;
ei->bstrHelpFile = NULL;
ei->m_dwHelpContext = 0;
2000-08-03 04:34:59 +00:00
}
return (IErrorInfo *)ei;
}
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);
2000-08-03 04:34:59 +00:00
*ppvoid = NULL;
if(IsEqualIID(riid, &IID_IErrorInfo))
{
2002-05-31 23:06:46 +00:00
*ppvoid = _IErrorInfo_(This);
2000-08-03 04:34:59 +00:00
}
else if(IsEqualIID(riid, &IID_ICreateErrorInfo))
{
*ppvoid = _ICreateErrorInfo_(This);
}
else if(IsEqualIID(riid, &IID_ISupportErrorInfo))
{
*ppvoid = _ISupportErrorInfo_(This);
}
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);
2000-08-03 04:34:59 +00:00
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);
2000-08-03 04:34:59 +00:00
if (!ref)
2000-08-03 04:34:59 +00:00
{
TRACE("-- destroying IErrorInfo(%p)\n",This);
HeapFree(GetProcessHeap(),0,This);
return 0;
}
return ref;
2000-08-03 04:34:59 +00:00
}
static HRESULT WINAPI IErrorInfoImpl_GetGUID(
IErrorInfo* iface,
2002-05-31 23:06:46 +00:00
GUID * pGUID)
2000-08-03 04:34:59 +00:00
{
ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
TRACE("(%p)->(count=%u)\n",This,This->ref);
if(!pGUID )return E_INVALIDARG;
*pGUID = This->m_Guid;
2000-08-03 04:34:59 +00:00
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 = ERRORINFO_SysAllocString(This->bstrSource);
return S_OK;
2000-08-03 04:34:59 +00:00
}
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 = ERRORINFO_SysAllocString(This->bstrDescription);
2002-05-31 23:06:46 +00:00
return S_OK;
2000-08-03 04:34:59 +00:00
}
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 = ERRORINFO_SysAllocString(This->bstrHelpFile);
2002-05-31 23:06:46 +00:00
return S_OK;
2000-08-03 04:34:59 +00:00
}
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;
2002-05-31 23:06:46 +00:00
return S_OK;
2000-08-03 04:34:59 +00:00
}
static const IErrorInfoVtbl IErrorInfoImpl_VTable =
2000-08-03 04:34:59 +00:00
{
IErrorInfoImpl_QueryInterface,
IErrorInfoImpl_AddRef,
IErrorInfoImpl_Release,
2002-05-31 23:06:46 +00:00
2000-08-03 04:34:59 +00:00
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);
2000-08-03 04:34:59 +00:00
TRACE("(%p)\n", This);
return IErrorInfo_QueryInterface(_IErrorInfo_(This), riid, ppvoid);
}
static ULONG WINAPI ICreateErrorInfoImpl_AddRef(
ICreateErrorInfo* iface)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)\n", This);
return IErrorInfo_AddRef(_IErrorInfo_(This));
}
static ULONG WINAPI ICreateErrorInfoImpl_Release(
ICreateErrorInfo* iface)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)\n", This);
return IErrorInfo_Release(_IErrorInfo_(This));
}
static HRESULT WINAPI ICreateErrorInfoImpl_SetGUID(
ICreateErrorInfo* iface,
REFGUID rguid)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)->(%s)\n", This, debugstr_guid(rguid));
This->m_Guid = *rguid;
2000-08-03 04:34:59 +00:00
return S_OK;
}
static HRESULT WINAPI ICreateErrorInfoImpl_SetSource(
ICreateErrorInfo* iface,
LPOLESTR szSource)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
2004-11-29 17:00:39 +00:00
TRACE("(%p): %s\n",This, debugstr_w(szSource));
if (This->bstrSource != NULL)
ERRORINFO_SysFreeString(This->bstrSource);
This->bstrSource = ERRORINFO_SysAllocString(szSource);
2002-05-31 23:06:46 +00:00
return S_OK;
2000-08-03 04:34:59 +00:00
}
static HRESULT WINAPI ICreateErrorInfoImpl_SetDescription(
ICreateErrorInfo* iface,
LPOLESTR szDescription)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
2004-11-29 17:00:39 +00:00
TRACE("(%p): %s\n",This, debugstr_w(szDescription));
if (This->bstrDescription != NULL)
ERRORINFO_SysFreeString(This->bstrDescription);
This->bstrDescription = ERRORINFO_SysAllocString(szDescription);
2002-05-31 23:06:46 +00:00
return S_OK;
2000-08-03 04:34:59 +00:00
}
static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpFile(
ICreateErrorInfo* iface,
LPOLESTR szHelpFile)
{
ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
TRACE("(%p,%s)\n",This,debugstr_w(szHelpFile));
if (This->bstrHelpFile != NULL)
ERRORINFO_SysFreeString(This->bstrHelpFile);
This->bstrHelpFile = ERRORINFO_SysAllocString(szHelpFile);
return S_OK;
2000-08-03 04:34:59 +00:00
}
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;
2000-08-03 04:34:59 +00:00
}
static const ICreateErrorInfoVtbl ICreateErrorInfoImpl_VTable =
2000-08-03 04:34:59 +00:00
{
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);
TRACE("(%p)\n", This);
2002-05-31 23:06:46 +00:00
2000-08-03 04:34:59 +00:00
return IErrorInfo_QueryInterface(_IErrorInfo_(This), riid, ppvoid);
}
static ULONG WINAPI ISupportErrorInfoImpl_AddRef(
ISupportErrorInfo* iface)
{
ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)\n", This);
return IErrorInfo_AddRef(_IErrorInfo_(This));
}
static ULONG WINAPI ISupportErrorInfoImpl_Release(
ISupportErrorInfo* iface)
{
ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)\n", This);
return IErrorInfo_Release(_IErrorInfo_(This));
}
static HRESULT WINAPI ISupportErrorInfoImpl_InterfaceSupportsErrorInfo(
ISupportErrorInfo* iface,
REFIID riid)
{
ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
2000-08-03 04:34:59 +00:00
TRACE("(%p)->(%s)\n", This, debugstr_guid(riid));
return (IsEqualIID(riid, &This->m_Guid)) ? S_OK : S_FALSE;
2000-08-03 04:34:59 +00:00
}
static const ISupportErrorInfoVtbl ISupportErrorInfoImpl_VTable =
2000-08-03 04:34:59 +00:00
{
ISupportErrorInfoImpl_QueryInterface,
ISupportErrorInfoImpl_AddRef,
ISupportErrorInfoImpl_Release,
ISupportErrorInfoImpl_InterfaceSupportsErrorInfo
};
/***********************************************************************
2003-09-11 03:06:25 +00:00
* 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)
{
2000-08-03 04:34:59 +00:00
IErrorInfo * pei;
HRESULT res;
TRACE("(%p)\n", pperrinfo);
if(! pperrinfo ) return E_INVALIDARG;
2000-08-03 04:34:59 +00:00
if(!(pei=IErrorInfoImpl_Constructor()))return E_OUTOFMEMORY;
2002-05-31 23:06:46 +00:00
2000-08-03 04:34:59 +00:00
res = IErrorInfo_QueryInterface(pei, &IID_ICreateErrorInfo, (LPVOID*)pperrinfo);
IErrorInfo_Release(pei);
return res;
}
/***********************************************************************
2003-09-11 03:06:25 +00:00
* 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);
2000-08-03 04:34:59 +00:00
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;
2000-08-03 04:34:59 +00:00
/* clear thread error state */
COM_CurrentInfo()->errorinfo = NULL;
2000-08-03 04:34:59 +00:00
return S_OK;
}
/***********************************************************************
2003-09-11 03:06:25 +00:00
* 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)
{
2000-08-03 04:34:59 +00:00
IErrorInfo * pei;
TRACE("(%d, %p)\n", dwReserved, perrinfo);
if (dwReserved)
{
ERR("dwReserved (0x%x) != 0\n", dwReserved);
return E_INVALIDARG;
}
2000-08-03 04:34:59 +00:00
/* release old errorinfo */
pei = COM_CurrentInfo()->errorinfo;
if (pei) IErrorInfo_Release(pei);
2000-08-03 04:34:59 +00:00
/* set to new value */
COM_CurrentInfo()->errorinfo = perrinfo;
if (perrinfo) IErrorInfo_AddRef(perrinfo);
2000-08-03 04:34:59 +00:00
return S_OK;
}