wininet/tests: Don't call GetLastError() twice.
[wine] / dlls / ole32 / errorinfo.c
1 /*
2  * ErrorInfo API
3  *
4  * Copyright 2000 Patrik Stridvall, Juergen Schmied
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  *
20  * NOTES:
21  *
22  * The errorinfo is a per-thread object. The reference is stored in the
23  * TEB at offset 0xf80.
24  */
25
26 #include <stdarg.h>
27 #include <string.h>
28
29 #define COBJMACROS
30
31 #include "windef.h"
32 #include "winbase.h"
33 #include "objbase.h"
34 #include "oleauto.h"
35 #include "winerror.h"
36
37 #include "wine/unicode.h"
38 #include "compobj_private.h"
39
40 #include "wine/debug.h"
41
42 WINE_DEFAULT_DEBUG_CHANNEL(ole);
43
44 /* this code is from SysAllocStringLen (ole2disp.c in oleaut32) */
45 static BSTR ERRORINFO_SysAllocString(const OLECHAR* in)
46 {
47     DWORD  bufferSize;
48     DWORD* newBuffer;
49     WCHAR* stringBuffer;
50     DWORD len;
51
52     if (in == NULL)
53         return NULL;
54     /*
55      * Find the length of the buffer passed-in, in bytes.
56      */
57     len = strlenW(in);
58     bufferSize = len * sizeof (WCHAR);
59
60     /*
61      * Allocate a new buffer to hold the string.
62      * don't forget to keep an empty spot at the beginning of the
63      * buffer for the character count and an extra character at the
64      * end for the '\0'.
65      */
66     newBuffer = HeapAlloc(GetProcessHeap(), 0,
67                                  bufferSize + sizeof(WCHAR) + sizeof(DWORD));
68
69     /*
70      * If the memory allocation failed, return a null pointer.
71      */
72     if (newBuffer==0)
73       return 0;
74
75     /*
76      * Copy the length of the string in the placeholder.
77      */
78     *newBuffer = bufferSize;
79
80     /*
81      * Skip the byte count.
82      */
83     newBuffer++;
84
85     /*
86      * Copy the information in the buffer.  It is not possible to pass 
87      * a NULL pointer here. 
88      */
89     memcpy(newBuffer, in, bufferSize);
90
91     /*
92      * Make sure that there is a nul character at the end of the
93      * string.
94      */
95     stringBuffer = (WCHAR*)newBuffer;
96     stringBuffer[len] = 0;
97
98     return stringBuffer;
99 }
100
101 /* this code is from SysFreeString (ole2disp.c in oleaut32)*/
102 static VOID ERRORINFO_SysFreeString(BSTR in)
103 {
104     DWORD* bufferPointer;
105
106     /* NULL is a valid parameter */
107     if(!in) return;
108
109     /*
110      * We have to be careful when we free a BSTR pointer, it points to
111      * the beginning of the string but it skips the byte count contained
112      * before the string.
113      */
114     bufferPointer = (DWORD*)in;
115
116     bufferPointer--;
117
118     /*
119      * Free the memory from it's "real" origin.
120      */
121     HeapFree(GetProcessHeap(), 0, bufferPointer);
122 }
123
124
125 typedef struct ErrorInfoImpl
126 {
127         const IErrorInfoVtbl           *lpvtei;
128         const ICreateErrorInfoVtbl     *lpvtcei;
129         const ISupportErrorInfoVtbl    *lpvtsei;
130         LONG                            ref;
131
132         GUID m_Guid;
133         BSTR bstrSource;
134         BSTR bstrDescription;
135         BSTR bstrHelpFile;
136         DWORD m_dwHelpContext;
137 } ErrorInfoImpl;
138
139 static const IErrorInfoVtbl        IErrorInfoImpl_VTable;
140 static const ICreateErrorInfoVtbl  ICreateErrorInfoImpl_VTable;
141 static const ISupportErrorInfoVtbl ISupportErrorInfoImpl_VTable;
142
143 /*
144  converts an object pointer to This
145  */
146
147 static inline ErrorInfoImpl *impl_from_IErrorInfo( IErrorInfo *iface )
148 {
149     return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtei));
150 }
151
152 static inline ErrorInfoImpl *impl_from_ICreateErrorInfo( ICreateErrorInfo *iface )
153 {
154     return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtcei));
155 }
156
157 static inline ErrorInfoImpl *impl_from_ISupportErrorInfo( ISupportErrorInfo *iface )
158 {
159     return (ErrorInfoImpl *)((char*)iface - FIELD_OFFSET(ErrorInfoImpl, lpvtsei));
160 }
161
162
163 /*
164  converts This to an object pointer
165  */
166 #define _IErrorInfo_(This)              ((IErrorInfo*)&(This)->lpvtei)
167 #define _ICreateErrorInfo_(This)        (&(This)->lpvtcei)
168 #define _ISupportErrorInfo_(This)       (&(This)->lpvtsei)
169
170 static IErrorInfo * IErrorInfoImpl_Constructor(void)
171 {
172         ErrorInfoImpl * ei = HeapAlloc(GetProcessHeap(), 0, sizeof(ErrorInfoImpl));
173         if (ei)
174         {
175           ei->lpvtei = &IErrorInfoImpl_VTable;
176           ei->lpvtcei = &ICreateErrorInfoImpl_VTable;
177           ei->lpvtsei = &ISupportErrorInfoImpl_VTable;
178           ei->ref = 1;
179           ei->bstrSource = NULL;
180           ei->bstrDescription = NULL;
181           ei->bstrHelpFile = NULL;
182           ei->m_dwHelpContext = 0;
183         }
184         return (IErrorInfo *)ei;
185 }
186
187
188 static HRESULT WINAPI IErrorInfoImpl_QueryInterface(
189         IErrorInfo* iface,
190         REFIID     riid,
191         VOID**     ppvoid)
192 {
193         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
194         TRACE("(%p)->(%s,%p)\n",This,debugstr_guid(riid),ppvoid);
195
196         *ppvoid = NULL;
197
198         if(IsEqualIID(riid, &IID_IErrorInfo))
199         {
200           *ppvoid = _IErrorInfo_(This);
201         }
202         else if(IsEqualIID(riid, &IID_ICreateErrorInfo))
203         {
204           *ppvoid = _ICreateErrorInfo_(This);
205         }
206         else if(IsEqualIID(riid, &IID_ISupportErrorInfo))
207         {
208           *ppvoid = _ISupportErrorInfo_(This);
209         }
210
211         if(*ppvoid)
212         {
213           IUnknown_AddRef( (IUnknown*)*ppvoid );
214           TRACE("-- Interface: (%p)->(%p)\n",ppvoid,*ppvoid);
215           return S_OK;
216         }
217         TRACE("-- Interface: E_NOINTERFACE\n");
218         return E_NOINTERFACE;
219 }
220
221 static ULONG WINAPI IErrorInfoImpl_AddRef(
222         IErrorInfo* iface)
223 {
224         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
225         TRACE("(%p)->(count=%u)\n",This,This->ref);
226         return InterlockedIncrement(&This->ref);
227 }
228
229 static ULONG WINAPI IErrorInfoImpl_Release(
230         IErrorInfo* iface)
231 {
232         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
233         ULONG ref = InterlockedDecrement(&This->ref);
234
235         TRACE("(%p)->(count=%u)\n",This,ref+1);
236
237         if (!ref)
238         {
239           TRACE("-- destroying IErrorInfo(%p)\n",This);
240
241           ERRORINFO_SysFreeString(This->bstrSource);
242           ERRORINFO_SysFreeString(This->bstrDescription);
243           ERRORINFO_SysFreeString(This->bstrHelpFile);
244           HeapFree(GetProcessHeap(),0,This);
245           return 0;
246         }
247         return ref;
248 }
249
250 static HRESULT WINAPI IErrorInfoImpl_GetGUID(
251         IErrorInfo* iface,
252         GUID * pGUID)
253 {
254         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
255         TRACE("(%p)->(count=%u)\n",This,This->ref);
256         if(!pGUID )return E_INVALIDARG;
257         *pGUID = This->m_Guid;
258         return S_OK;
259 }
260
261 static HRESULT WINAPI IErrorInfoImpl_GetSource(
262         IErrorInfo* iface,
263         BSTR *pBstrSource)
264 {
265         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
266         TRACE("(%p)->(pBstrSource=%p)\n",This,pBstrSource);
267         if (pBstrSource == NULL)
268             return E_INVALIDARG;
269         *pBstrSource = ERRORINFO_SysAllocString(This->bstrSource);
270         return S_OK;
271 }
272
273 static HRESULT WINAPI IErrorInfoImpl_GetDescription(
274         IErrorInfo* iface,
275         BSTR *pBstrDescription)
276 {
277         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
278
279         TRACE("(%p)->(pBstrDescription=%p)\n",This,pBstrDescription);
280         if (pBstrDescription == NULL)
281             return E_INVALIDARG;
282         *pBstrDescription = ERRORINFO_SysAllocString(This->bstrDescription);
283
284         return S_OK;
285 }
286
287 static HRESULT WINAPI IErrorInfoImpl_GetHelpFile(
288         IErrorInfo* iface,
289         BSTR *pBstrHelpFile)
290 {
291         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
292
293         TRACE("(%p)->(pBstrHelpFile=%p)\n",This, pBstrHelpFile);
294         if (pBstrHelpFile == NULL)
295             return E_INVALIDARG;
296         *pBstrHelpFile = ERRORINFO_SysAllocString(This->bstrHelpFile);
297
298         return S_OK;
299 }
300
301 static HRESULT WINAPI IErrorInfoImpl_GetHelpContext(
302         IErrorInfo* iface,
303         DWORD *pdwHelpContext)
304 {
305         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
306         TRACE("(%p)->(pdwHelpContext=%p)\n",This, pdwHelpContext);
307         if (pdwHelpContext == NULL)
308             return E_INVALIDARG;
309         *pdwHelpContext = This->m_dwHelpContext;
310
311         return S_OK;
312 }
313
314 static const IErrorInfoVtbl IErrorInfoImpl_VTable =
315 {
316   IErrorInfoImpl_QueryInterface,
317   IErrorInfoImpl_AddRef,
318   IErrorInfoImpl_Release,
319
320   IErrorInfoImpl_GetGUID,
321   IErrorInfoImpl_GetSource,
322   IErrorInfoImpl_GetDescription,
323   IErrorInfoImpl_GetHelpFile,
324   IErrorInfoImpl_GetHelpContext
325 };
326
327
328 static HRESULT WINAPI ICreateErrorInfoImpl_QueryInterface(
329         ICreateErrorInfo* iface,
330         REFIID     riid,
331         VOID**     ppvoid)
332 {
333         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
334         TRACE("(%p)\n", This);
335         return IErrorInfo_QueryInterface(_IErrorInfo_(This), riid, ppvoid);
336 }
337
338 static ULONG WINAPI ICreateErrorInfoImpl_AddRef(
339         ICreateErrorInfo* iface)
340 {
341         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
342         TRACE("(%p)\n", This);
343         return IErrorInfo_AddRef(_IErrorInfo_(This));
344 }
345
346 static ULONG WINAPI ICreateErrorInfoImpl_Release(
347         ICreateErrorInfo* iface)
348 {
349         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
350         TRACE("(%p)\n", This);
351         return IErrorInfo_Release(_IErrorInfo_(This));
352 }
353
354
355 static HRESULT WINAPI ICreateErrorInfoImpl_SetGUID(
356         ICreateErrorInfo* iface,
357         REFGUID rguid)
358 {
359         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
360         TRACE("(%p)->(%s)\n", This, debugstr_guid(rguid));
361         This->m_Guid = *rguid;
362         return S_OK;
363 }
364
365 static HRESULT WINAPI ICreateErrorInfoImpl_SetSource(
366         ICreateErrorInfo* iface,
367         LPOLESTR szSource)
368 {
369         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
370         TRACE("(%p): %s\n",This, debugstr_w(szSource));
371         if (This->bstrSource != NULL)
372             ERRORINFO_SysFreeString(This->bstrSource);
373         This->bstrSource = ERRORINFO_SysAllocString(szSource);
374
375         return S_OK;
376 }
377
378 static HRESULT WINAPI ICreateErrorInfoImpl_SetDescription(
379         ICreateErrorInfo* iface,
380         LPOLESTR szDescription)
381 {
382         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
383         TRACE("(%p): %s\n",This, debugstr_w(szDescription));
384         if (This->bstrDescription != NULL)
385             ERRORINFO_SysFreeString(This->bstrDescription);
386         This->bstrDescription = ERRORINFO_SysAllocString(szDescription);
387
388         return S_OK;
389 }
390
391 static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpFile(
392         ICreateErrorInfo* iface,
393         LPOLESTR szHelpFile)
394 {
395         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
396         TRACE("(%p,%s)\n",This,debugstr_w(szHelpFile));
397         if (This->bstrHelpFile != NULL)
398             ERRORINFO_SysFreeString(This->bstrHelpFile);
399         This->bstrHelpFile = ERRORINFO_SysAllocString(szHelpFile);
400         return S_OK;
401 }
402
403 static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpContext(
404         ICreateErrorInfo* iface,
405         DWORD dwHelpContext)
406 {
407         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
408         TRACE("(%p,%d)\n",This,dwHelpContext);
409         This->m_dwHelpContext = dwHelpContext;
410         return S_OK;
411 }
412
413 static const ICreateErrorInfoVtbl ICreateErrorInfoImpl_VTable =
414 {
415   ICreateErrorInfoImpl_QueryInterface,
416   ICreateErrorInfoImpl_AddRef,
417   ICreateErrorInfoImpl_Release,
418
419   ICreateErrorInfoImpl_SetGUID,
420   ICreateErrorInfoImpl_SetSource,
421   ICreateErrorInfoImpl_SetDescription,
422   ICreateErrorInfoImpl_SetHelpFile,
423   ICreateErrorInfoImpl_SetHelpContext
424 };
425
426 static HRESULT WINAPI ISupportErrorInfoImpl_QueryInterface(
427         ISupportErrorInfo* iface,
428         REFIID     riid,
429         VOID**     ppvoid)
430 {
431         ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
432         TRACE("(%p)\n", This);
433
434         return IErrorInfo_QueryInterface(_IErrorInfo_(This), riid, ppvoid);
435 }
436
437 static ULONG WINAPI ISupportErrorInfoImpl_AddRef(
438         ISupportErrorInfo* iface)
439 {
440         ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
441         TRACE("(%p)\n", This);
442         return IErrorInfo_AddRef(_IErrorInfo_(This));
443 }
444
445 static ULONG WINAPI ISupportErrorInfoImpl_Release(
446         ISupportErrorInfo* iface)
447 {
448         ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
449         TRACE("(%p)\n", This);
450         return IErrorInfo_Release(_IErrorInfo_(This));
451 }
452
453
454 static HRESULT WINAPI ISupportErrorInfoImpl_InterfaceSupportsErrorInfo(
455         ISupportErrorInfo* iface,
456         REFIID riid)
457 {
458         ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
459         TRACE("(%p)->(%s)\n", This, debugstr_guid(riid));
460         return (IsEqualIID(riid, &This->m_Guid)) ? S_OK : S_FALSE;
461 }
462
463 static const ISupportErrorInfoVtbl ISupportErrorInfoImpl_VTable =
464 {
465   ISupportErrorInfoImpl_QueryInterface,
466   ISupportErrorInfoImpl_AddRef,
467   ISupportErrorInfoImpl_Release,
468
469
470   ISupportErrorInfoImpl_InterfaceSupportsErrorInfo
471 };
472
473 /***********************************************************************
474  *              CreateErrorInfo (OLE32.@)
475  *
476  * Creates an object used to set details for an error info object.
477  *
478  * PARAMS
479  *  pperrinfo [O]. Address where error info creation object will be stored.
480  *
481  * RETURNS
482  *  Success: S_OK.
483  *  Failure: HRESULT code.
484  */
485 HRESULT WINAPI CreateErrorInfo(ICreateErrorInfo **pperrinfo)
486 {
487         IErrorInfo * pei;
488         HRESULT res;
489         TRACE("(%p)\n", pperrinfo);
490         if(! pperrinfo ) return E_INVALIDARG;
491         if(!(pei=IErrorInfoImpl_Constructor()))return E_OUTOFMEMORY;
492
493         res = IErrorInfo_QueryInterface(pei, &IID_ICreateErrorInfo, (LPVOID*)pperrinfo);
494         IErrorInfo_Release(pei);
495         return res;
496 }
497
498 /***********************************************************************
499  *              GetErrorInfo (OLE32.@)
500  *
501  * Retrieves the error information object for the current thread.
502  *
503  * PARAMS
504  *  dwReserved [I]. Reserved. Must be zero.
505  *  pperrinfo  [O]. Address where error information object will be stored on return.
506  *
507  * RETURNS
508  *  Success: S_OK if an error information object was set for the current thread.
509  *           S_FALSE if otherwise.
510  *  Failure: E_INVALIDARG if dwReserved is not zero.
511  *
512  * NOTES
513  *  This function causes the current error info object for the thread to be
514  *  cleared if one was set beforehand.
515  */
516 HRESULT WINAPI GetErrorInfo(ULONG dwReserved, IErrorInfo **pperrinfo)
517 {
518         TRACE("(%d, %p, %p)\n", dwReserved, pperrinfo, COM_CurrentInfo()->errorinfo);
519
520         if (dwReserved)
521         {
522                 ERR("dwReserved (0x%x) != 0\n", dwReserved);
523                 return E_INVALIDARG;
524         }
525
526         if(!pperrinfo) return E_INVALIDARG;
527
528         if (!COM_CurrentInfo()->errorinfo)
529         {
530            *pperrinfo = NULL;
531            return S_FALSE;
532         }
533
534         *pperrinfo = COM_CurrentInfo()->errorinfo;
535         
536         /* clear thread error state */
537         COM_CurrentInfo()->errorinfo = NULL;
538         return S_OK;
539 }
540
541 /***********************************************************************
542  *              SetErrorInfo (OLE32.@)
543  *
544  * Sets the error information object for the current thread.
545  *
546  * PARAMS
547  *  dwReserved [I] Reserved. Must be zero.
548  *  perrinfo   [I] Error info object.
549  *
550  * RETURNS
551  *  Success: S_OK.
552  *  Failure: E_INVALIDARG if dwReserved is not zero.
553  */
554 HRESULT WINAPI SetErrorInfo(ULONG dwReserved, IErrorInfo *perrinfo)
555 {
556         IErrorInfo * pei;
557
558         TRACE("(%d, %p)\n", dwReserved, perrinfo);
559
560         if (dwReserved)
561         {
562                 ERR("dwReserved (0x%x) != 0\n", dwReserved);
563                 return E_INVALIDARG;
564         }
565
566         /* release old errorinfo */
567         pei = COM_CurrentInfo()->errorinfo;
568         if (pei) IErrorInfo_Release(pei);
569
570         /* set to new value */
571         COM_CurrentInfo()->errorinfo = perrinfo;
572         if (perrinfo) IErrorInfo_AddRef(perrinfo);
573         
574         return S_OK;
575 }