src/msw/ole/automtn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/ole/automtn.cpp
   3 // Purpose:     OLE automation utilities
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     11/6/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998, Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #if defined(__BORLANDC__)
  16     #pragma hdrstop
  17 #endif
  18
  19 // With Borland C++, all samples crash if this is compiled in.
  20 #if (defined(__BORLANDC__) && (__BORLANDC__ < 0x520)) || defined(__CYGWIN10__)
  21     #undef wxUSE_OLE_AUTOMATION
  22     #define wxUSE_OLE_AUTOMATION 0
  23 #endif
  24
  25 #if wxUSE_OLE_AUTOMATION
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/log.h"
  29     #include "wx/math.h"
  30 #endif
  31
  32 #define _FORCENAMELESSUNION
  33 #include "wx/msw/private.h"
  34 #include "wx/msw/ole/oleutils.h"
  35 #include "wx/msw/ole/automtn.h"
  36
  37 #ifdef __WXWINCE__
  38 #include "wx/msw/wince/time.h"
  39 #else
  40 #include <time.h>
  41 #endif
  42
  43 #include <wtypes.h>
  44 #include <unknwn.h>
  45
  46 #include <ole2.h>
  47 #define _huge
  48
  49 #ifndef __WXWINCE__
  50 #include <ole2ver.h>
  51 #endif
  52
  53 #include <oleauto.h>
  54
  55 #if wxUSE_DATETIME
  56 #include "wx/datetime.h"
  57 #endif // wxUSE_TIMEDATE
  58
  59 static void ClearVariant(VARIANTARG *pvarg) ;
  60 static void ReleaseVariant(VARIANTARG *pvarg) ;
  61 // static void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr);
  62
  63 /*
  64  * wxAutomationObject
  65  */
  66
  67 wxAutomationObject::wxAutomationObject(WXIDISPATCH* dispatchPtr)
  68 {
  69     m_dispatchPtr = dispatchPtr;
  70 }
  71
  72 wxAutomationObject::~wxAutomationObject()
  73 {
  74     if (m_dispatchPtr)
  75     {
  76         ((IDispatch*)m_dispatchPtr)->Release();
  77         m_dispatchPtr = NULL;
  78     }
  79 }
  80
  81 #define INVOKEARG(i) (args ? args[i] : *(ptrArgs[i]))
  82
  83 // For Put/Get, no named arguments are allowed.
  84 bool wxAutomationObject::Invoke(const wxString& member, int action,
  85         wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[]) const
  86 {
  87     if (!m_dispatchPtr)
  88         return false;
  89
  90     // nonConstMember is necessary because the wxString class doesn't have enough consts...
  91     wxString nonConstMember(member);
  92
  93     int ch = nonConstMember.Find('.');
  94     if (ch != -1)
  95     {
  96         // Use dot notation to get the next object
  97         wxString member2(nonConstMember.Left((size_t) ch));
  98         wxString rest(nonConstMember.Right(nonConstMember.length() - ch - 1));
  99         wxAutomationObject obj;
 100         if (!GetObject(obj, member2))
 101             return false;
 102         return obj.Invoke(rest, action, retValue, noArgs, args, ptrArgs);
 103     }
 104
 105     VARIANTARG vReturn;
 106     ClearVariant(& vReturn);
 107
 108     VARIANTARG* vReturnPtr = & vReturn;
 109
 110     // Find number of names args
 111     int namedArgCount = 0;
 112     int i;
 113     for (i = 0; i < noArgs; i++)
 114         if (!INVOKEARG(i).GetName().IsNull())
 115         {
 116             namedArgCount ++;
 117         }
 118
 119     int namedArgStringCount = namedArgCount + 1;
 120     BSTR* argNames = new BSTR[namedArgStringCount];
 121     argNames[0] = wxConvertStringToOle(member);
 122
 123     // Note that arguments are specified in reverse order
 124     // (all totally logical; hey, we're dealing with OLE here.)
 125
 126     int j = 0;
 127     for (i = 0; i < namedArgCount; i++)
 128     {
 129         if (!INVOKEARG(i).GetName().IsNull())
 130         {
 131             argNames[(namedArgCount-j)] = wxConvertStringToOle(INVOKEARG(i).GetName());
 132             j ++;
 133         }
 134     }
 135
 136     // + 1 for the member name, + 1 again in case we're a 'put'
 137     DISPID* dispIds = new DISPID[namedArgCount + 2];
 138
 139     HRESULT hr;
 140     DISPPARAMS dispparams;
 141     unsigned int uiArgErr;
 142     EXCEPINFO excep;
 143
 144     // Get the IDs for the member and its arguments.  GetIDsOfNames expects the
 145     // member name as the first name, followed by argument names (if any).
 146     hr = ((IDispatch*)m_dispatchPtr)->GetIDsOfNames(IID_NULL, argNames,
 147                                 1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
 148     if (FAILED(hr))
 149     {
 150 //        ShowException(szMember, hr, NULL, 0);
 151         delete[] argNames;
 152         delete[] dispIds;
 153         return false;
 154     }
 155
 156     // if doing a property put(ref), we need to adjust the first argument to have a
 157     // named arg of DISPID_PROPERTYPUT.
 158     if (action & (DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF))
 159     {
 160         namedArgCount = 1;
 161         dispIds[1] = DISPID_PROPERTYPUT;
 162         vReturnPtr = (VARIANTARG*) NULL;
 163     }
 164
 165     // Convert the wxVariants to VARIANTARGs
 166     VARIANTARG* oleArgs = new VARIANTARG[noArgs];
 167     for (i = 0; i < noArgs; i++)
 168     {
 169         // Again, reverse args
 170         if (!wxConvertVariantToOle(INVOKEARG((noArgs-1) - i), oleArgs[i]))
 171         {
 172             delete[] argNames;
 173             delete[] dispIds;
 174             delete[] oleArgs;
 175             return false;
 176         }
 177     }
 178
 179     dispparams.rgdispidNamedArgs = dispIds + 1;
 180     dispparams.rgvarg = oleArgs;
 181     dispparams.cArgs = noArgs;
 182     dispparams.cNamedArgs = namedArgCount;
 183
 184     excep.pfnDeferredFillIn = NULL;
 185
 186     hr = ((IDispatch*)m_dispatchPtr)->Invoke(dispIds[0], IID_NULL, LOCALE_SYSTEM_DEFAULT,
 187                         (WORD)action, &dispparams, vReturnPtr, &excep, &uiArgErr);
 188
 189     for (i = 0; i < namedArgStringCount; i++)
 190     {
 191         SysFreeString(argNames[i]);
 192     }
 193     delete[] argNames;
 194     delete[] dispIds;
 195
 196     for (i = 0; i < noArgs; i++)
 197         ReleaseVariant(& oleArgs[i]) ;
 198     delete[] oleArgs;
 199
 200     if (FAILED(hr))
 201     {
 202         // display the exception information if appropriate:
 203 //        ShowException((const char*) member, hr, &excep, uiArgErr);
 204
 205         // free exception structure information
 206         SysFreeString(excep.bstrSource);
 207         SysFreeString(excep.bstrDescription);
 208         SysFreeString(excep.bstrHelpFile);
 209
 210         if (vReturnPtr)
 211             ReleaseVariant(vReturnPtr);
 212         return false;
 213     }
 214     else
 215     {
 216         if (vReturnPtr)
 217         {
 218             // Convert result to wxVariant form
 219             wxConvertOleToVariant(vReturn, retValue);
 220             // Mustn't release the dispatch pointer
 221             if (vReturn.vt == VT_DISPATCH)
 222             {
 223                 vReturn.pdispVal = (IDispatch*) NULL;
 224             }
 225             ReleaseVariant(& vReturn);
 226         }
 227     }
 228     return true;
 229 }
 230
 231 // Invoke a member function
 232 wxVariant wxAutomationObject::CallMethod(const wxString& member, int noArgs, wxVariant args[])
 233 {
 234     wxVariant retVariant;
 235     if (!Invoke(member, DISPATCH_METHOD, retVariant, noArgs, args))
 236     {
 237         retVariant.MakeNull();
 238     }
 239     return retVariant;
 240 }
 241
 242 wxVariant wxAutomationObject::CallMethodArray(const wxString& member, int noArgs, const wxVariant **args)
 243 {
 244     wxVariant retVariant;
 245     if (!Invoke(member, DISPATCH_METHOD, retVariant, noArgs, NULL, args))
 246     {
 247         retVariant.MakeNull();
 248     }
 249     return retVariant;
 250 }
 251
 252 wxVariant wxAutomationObject::CallMethod(const wxString& member,
 253         const wxVariant& arg1, const wxVariant& arg2,
 254         const wxVariant& arg3, const wxVariant& arg4,
 255         const wxVariant& arg5, const wxVariant& arg6)
 256 {
 257     const wxVariant** args = new const wxVariant*[6];
 258     int i = 0;
 259     if (!arg1.IsNull())
 260     {
 261         args[i] = & arg1;
 262         i ++;
 263     }
 264     if (!arg2.IsNull())
 265     {
 266         args[i] = & arg2;
 267         i ++;
 268     }
 269     if (!arg3.IsNull())
 270     {
 271         args[i] = & arg3;
 272         i ++;
 273     }
 274     if (!arg4.IsNull())
 275     {
 276         args[i] = & arg4;
 277         i ++;
 278     }
 279     if (!arg5.IsNull())
 280     {
 281         args[i] = & arg5;
 282         i ++;
 283     }
 284     if (!arg6.IsNull())
 285     {
 286         args[i] = & arg6;
 287         i ++;
 288     }
 289     wxVariant retVariant;
 290     if (!Invoke(member, DISPATCH_METHOD, retVariant, i, NULL, args))
 291     {
 292         retVariant.MakeNull();
 293     }
 294     delete[] args;
 295     return retVariant;
 296 }
 297
 298 // Get/Set property
 299 wxVariant wxAutomationObject::GetPropertyArray(const wxString& property, int noArgs, const wxVariant **args) const
 300 {
 301     wxVariant retVariant;
 302     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, NULL, args))
 303     {
 304         retVariant.MakeNull();
 305     }
 306     return retVariant;
 307 }
 308 wxVariant wxAutomationObject::GetProperty(const wxString& property, int noArgs, wxVariant args[]) const
 309 {
 310     wxVariant retVariant;
 311     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 312     {
 313         retVariant.MakeNull();
 314     }
 315     return retVariant;
 316 }
 317
 318 wxVariant wxAutomationObject::GetProperty(const wxString& property,
 319         const wxVariant& arg1, const wxVariant& arg2,
 320         const wxVariant& arg3, const wxVariant& arg4,
 321         const wxVariant& arg5, const wxVariant& arg6)
 322 {
 323     const wxVariant** args = new const wxVariant*[6];
 324     int i = 0;
 325     if (!arg1.IsNull())
 326     {
 327         args[i] = & arg1;
 328         i ++;
 329     }
 330     if (!arg2.IsNull())
 331     {
 332         args[i] = & arg2;
 333         i ++;
 334     }
 335     if (!arg3.IsNull())
 336     {
 337         args[i] = & arg3;
 338         i ++;
 339     }
 340     if (!arg4.IsNull())
 341     {
 342         args[i] = & arg4;
 343         i ++;
 344     }
 345     if (!arg5.IsNull())
 346     {
 347         args[i] = & arg5;
 348         i ++;
 349     }
 350     if (!arg6.IsNull())
 351     {
 352         args[i] = & arg6;
 353         i ++;
 354     }
 355     wxVariant retVariant;
 356     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, i, NULL, args))
 357     {
 358         retVariant.MakeNull();
 359     }
 360     delete[] args;
 361     return retVariant;
 362 }
 363
 364 bool wxAutomationObject::PutProperty(const wxString& property, int noArgs, wxVariant args[])
 365 {
 366     wxVariant retVariant;
 367     if (!Invoke(property, DISPATCH_PROPERTYPUT, retVariant, noArgs, args))
 368     {
 369         return false;
 370     }
 371     return true;
 372 }
 373
 374 bool wxAutomationObject::PutPropertyArray(const wxString& property, int noArgs, const wxVariant **args)
 375 {
 376     wxVariant retVariant;
 377     if (!Invoke(property, DISPATCH_PROPERTYPUT, retVariant, noArgs, NULL, args))
 378     {
 379         return false;
 380     }
 381     return true;
 382 }
 383
 384 bool wxAutomationObject::PutProperty(const wxString& property,
 385         const wxVariant& arg1, const wxVariant& arg2,
 386         const wxVariant& arg3, const wxVariant& arg4,
 387         const wxVariant& arg5, const wxVariant& arg6)
 388 {
 389     const wxVariant** args = new const wxVariant*[6];
 390     int i = 0;
 391     if (!arg1.IsNull())
 392     {
 393         args[i] = & arg1;
 394         i ++;
 395     }
 396     if (!arg2.IsNull())
 397     {
 398         args[i] = & arg2;
 399         i ++;
 400     }
 401     if (!arg3.IsNull())
 402     {
 403         args[i] = & arg3;
 404         i ++;
 405     }
 406     if (!arg4.IsNull())
 407     {
 408         args[i] = & arg4;
 409         i ++;
 410     }
 411     if (!arg5.IsNull())
 412     {
 413         args[i] = & arg5;
 414         i ++;
 415     }
 416     if (!arg6.IsNull())
 417     {
 418         args[i] = & arg6;
 419         i ++;
 420     }
 421     wxVariant retVariant;
 422     bool ret = Invoke(property, DISPATCH_PROPERTYPUT, retVariant, i, NULL, args);
 423     delete[] args;
 424     return ret;
 425 }
 426
 427
 428 // Uses DISPATCH_PROPERTYGET
 429 // and returns a dispatch pointer. The calling code should call Release
 430 // on the pointer, though this could be implicit by constructing an wxAutomationObject
 431 // with it and letting the destructor call Release.
 432 WXIDISPATCH* wxAutomationObject::GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const
 433 {
 434     wxVariant retVariant;
 435     if (Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 436     {
 437         if (retVariant.GetType() == wxT("void*"))
 438         {
 439             return (WXIDISPATCH*) retVariant.GetVoidPtr();
 440         }
 441     }
 442
 443     return (WXIDISPATCH*) NULL;
 444 }
 445
 446 // Uses DISPATCH_PROPERTYGET
 447 // and returns a dispatch pointer. The calling code should call Release
 448 // on the pointer, though this could be implicit by constructing an wxAutomationObject
 449 // with it and letting the destructor call Release.
 450 WXIDISPATCH* wxAutomationObject::GetDispatchProperty(const wxString& property, int noArgs, const wxVariant **args) const
 451 {
 452     wxVariant retVariant;
 453     if (Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, NULL, args))
 454     {
 455         if (retVariant.GetType() == wxT("void*"))
 456         {
 457             return (WXIDISPATCH*) retVariant.GetVoidPtr();
 458         }
 459     }
 460
 461     return (WXIDISPATCH*) NULL;
 462 }
 463
 464
 465 // A way of initialising another wxAutomationObject with a dispatch object
 466 bool wxAutomationObject::GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, wxVariant args[]) const
 467 {
 468     WXIDISPATCH* dispatch = GetDispatchProperty(property, noArgs, args);
 469     if (dispatch)
 470     {
 471         obj.SetDispatchPtr(dispatch);
 472         return true;
 473     }
 474     else
 475         return false;
 476 }
 477
 478 // A way of initialising another wxAutomationObject with a dispatch object
 479 bool wxAutomationObject::GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, const wxVariant **args) const
 480 {
 481     WXIDISPATCH* dispatch = GetDispatchProperty(property, noArgs, args);
 482     if (dispatch)
 483     {
 484         obj.SetDispatchPtr(dispatch);
 485         return true;
 486     }
 487     else
 488         return false;
 489 }
 490
 491 // Get a dispatch pointer from the current object associated
 492 // with a class id
 493 bool wxAutomationObject::GetInstance(const wxString& classId) const
 494 {
 495     if (m_dispatchPtr)
 496         return false;
 497
 498     CLSID clsId;
 499     IUnknown * pUnk = NULL;
 500
 501     wxBasicString unicodeName(classId);
 502
 503     if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 504     {
 505         wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
 506         return false;
 507     }
 508
 509     if (FAILED(GetActiveObject(clsId, NULL, &pUnk)))
 510     {
 511         wxLogWarning(wxT("Cannot find an active object"));
 512         return false;
 513     }
 514
 515     if (pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr) != S_OK)
 516     {
 517         wxLogWarning(wxT("Cannot find IDispatch interface"));
 518         return false;
 519     }
 520
 521     return true;
 522 }
 523
 524 // Get a dispatch pointer from a new object associated
 525 // with the given class id
 526 bool wxAutomationObject::CreateInstance(const wxString& classId) const
 527 {
 528     if (m_dispatchPtr)
 529         return false;
 530
 531     CLSID clsId;
 532
 533     wxBasicString unicodeName(classId);
 534
 535     if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 536     {
 537         wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
 538         return false;
 539     }
 540
 541     // start a new copy of Excel, grab the IDispatch interface
 542     if (FAILED(CoCreateInstance(clsId, NULL, CLSCTX_LOCAL_SERVER, IID_IDispatch, (void**)&m_dispatchPtr)))
 543     {
 544         wxLogWarning(wxT("Cannot start an instance of this class."));
 545         return false;
 546     }
 547
 548     return true;
 549 }
 550
 551
 552 WXDLLEXPORT bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant)
 553 {
 554     ClearVariant(&oleVariant);
 555     if (variant.IsNull())
 556     {
 557         oleVariant.vt = VT_NULL;
 558         return true;
 559     }
 560
 561     wxString type(variant.GetType());
 562
 563
 564     if (type == wxT("long"))
 565     {
 566         oleVariant.vt = VT_I4;
 567         oleVariant.lVal = variant.GetLong() ;
 568     }
 569     // cVal not always present
 570 #ifndef __GNUWIN32__
 571     else if (type == wxT("char"))
 572     {
 573         oleVariant.vt=VT_I1;            // Signed Char
 574         oleVariant.cVal=variant.GetChar();
 575     }
 576 #endif
 577     else if (type == wxT("double"))
 578     {
 579         oleVariant.vt = VT_R8;
 580         oleVariant.dblVal = variant.GetDouble();
 581     }
 582     else if (type == wxT("bool"))
 583     {
 584         oleVariant.vt = VT_BOOL;
 585         // 'bool' required for VC++ 4 apparently
 586 #if (defined(__VISUALC__) && (__VISUALC__ <= 1000))
 587         oleVariant.bool = variant.GetBool();
 588 #else
 589         oleVariant.boolVal = variant.GetBool();
 590 #endif
 591     }
 592     else if (type == wxT("string"))
 593     {
 594         wxString str( variant.GetString() );
 595         oleVariant.vt = VT_BSTR;
 596         oleVariant.bstrVal = wxConvertStringToOle(str);
 597     }
 598 #if wxUSE_DATETIME
 599     else if (type == wxT("datetime"))
 600     {
 601         wxDateTime date( variant.GetDateTime() );
 602         oleVariant.vt = VT_DATE;
 603
 604         long dosDateTime = date.GetAsDOS();
 605         short dosDate = short((dosDateTime & 0xFFFF0000) >> 16);
 606         short dosTime = short(dosDateTime & 0xFFFF);
 607
 608         DosDateTimeToVariantTime(dosDate, dosTime, & oleVariant.date);
 609     }
 610 #endif
 611     else if (type == wxT("void*"))
 612     {
 613         oleVariant.vt = VT_DISPATCH;
 614         oleVariant.pdispVal = (IDispatch*) variant.GetVoidPtr();
 615     }
 616     else if (type == wxT("list") || type == wxT("stringlist"))
 617     {
 618         oleVariant.vt = VT_VARIANT | VT_ARRAY;
 619
 620         SAFEARRAY *psa;
 621         SAFEARRAYBOUND saBound;
 622         VARIANTARG *pvargBase;
 623         VARIANTARG *pvarg;
 624         int i, j;
 625
 626         int iCount = variant.GetCount();
 627
 628         saBound.lLbound = 0;
 629         saBound.cElements = iCount;
 630
 631         psa = SafeArrayCreate(VT_VARIANT, 1, &saBound);
 632         if (psa == NULL)
 633             return false;
 634
 635         SafeArrayAccessData(psa, (void**)&pvargBase);
 636
 637         pvarg = pvargBase;
 638         for (i = 0; i < iCount; i++)
 639         {
 640             // copy each string in the list of strings
 641             wxVariant eachVariant(variant[i]);
 642             if (!wxConvertVariantToOle(eachVariant, * pvarg))
 643             {
 644                 // memory failure:  back out and free strings alloc'ed up to
 645                 // now, and then the array itself.
 646                 pvarg = pvargBase;
 647                 for (j = 0; j < i; j++)
 648                 {
 649                     SysFreeString(pvarg->bstrVal);
 650                     pvarg++;
 651                 }
 652                 SafeArrayDestroy(psa);
 653                 return false;
 654             }
 655             pvarg++;
 656         }
 657
 658         SafeArrayUnaccessData(psa);
 659
 660         oleVariant.parray = psa;
 661     }
 662     else
 663     {
 664         oleVariant.vt = VT_NULL;
 665         return false;
 666     }
 667     return true;
 668 }
 669
 670 #ifndef VT_TYPEMASK
 671 #define VT_TYPEMASK 0xfff
 672 #endif
 673
 674 WXDLLEXPORT bool wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant)
 675 {
 676     switch (oleVariant.vt & VT_TYPEMASK)
 677     {
 678     case VT_BSTR:
 679         {
 680             wxString str(wxConvertStringFromOle(oleVariant.bstrVal));
 681             variant = str;
 682             break;
 683         }
 684     case VT_DATE:
 685         {
 686 #if wxUSE_DATETIME
 687             unsigned short dosDate = 0;
 688             unsigned short dosTime = 0;
 689             VariantTimeToDosDateTime(oleVariant.date, & dosDate, & dosTime);
 690
 691             long dosDateTime = (dosDate << 16) | dosTime;
 692             wxDateTime date;
 693             date.SetFromDOS(dosDateTime);
 694             variant = date;
 695 #endif
 696             break;
 697         }
 698     case VT_I4:
 699         {
 700             variant = (long) oleVariant.lVal;
 701             break;
 702         }
 703     case VT_I2:
 704         {
 705             variant = (long) oleVariant.iVal;
 706             break;
 707         }
 708
 709     case VT_BOOL:
 710         {
 711 #if (defined(_MSC_VER) && (_MSC_VER <= 1000) && !defined(__MWERKS__) ) //GC
 712 #ifndef HAVE_BOOL // Can't use bool operator if no native bool type
 713             variant = (long) (oleVariant.bool != 0);
 714 #else
 715             variant = (bool) (oleVariant.bool != 0);
 716 #endif
 717 #else
 718 #ifndef HAVE_BOOL // Can't use bool operator if no native bool type
 719             variant = (long) (oleVariant.boolVal != 0);
 720 #else
 721             variant = (bool) (oleVariant.boolVal != 0);
 722 #endif
 723 #endif
 724             break;
 725         }
 726     case VT_R8:
 727         {
 728             variant = oleVariant.dblVal;
 729             break;
 730         }
 731     case VT_ARRAY:
 732         {
 733             variant.ClearList();
 734
 735             int cDims, cElements, i;
 736             VARIANTARG* pvdata;
 737
 738             // Iterate the dimensions: number of elements is x*y*z
 739             for (cDims = 0, cElements = 1;
 740                 cDims < oleVariant.parray->cDims; cDims ++)
 741                     cElements *= oleVariant.parray->rgsabound[cDims].cElements;
 742
 743             // Get a pointer to the data
 744             HRESULT hr = SafeArrayAccessData(oleVariant.parray, (void HUGEP* FAR*) & pvdata);
 745             if (hr != NOERROR)
 746                 return false;
 747             // Iterate the data.
 748             for (i = 0; i < cElements; i++)
 749             {
 750                 VARIANTARG& oleElement = pvdata[i];
 751                 wxVariant vElement;
 752                 if (!wxConvertOleToVariant(oleElement, vElement))
 753                     return false;
 754
 755                 variant.Append(vElement);
 756             }
 757             SafeArrayUnaccessData(oleVariant.parray);
 758             break;
 759         }
 760     case VT_DISPATCH:
 761         {
 762             variant = (void*) oleVariant.pdispVal;
 763             break;
 764         }
 765     case VT_NULL:
 766         {
 767             variant.MakeNull();
 768             break;
 769         }
 770     case VT_EMPTY:
 771         {
 772             break;    // Ignore Empty Variant, used only during destruction of objects
 773         }
 774     default:
 775         {
 776             wxLogError(wxT("wxAutomationObject::ConvertOleToVariant: Unknown variant value type"));
 777             return false;
 778         }
 779     }
 780     return true;
 781 }
 782
 783 /*
 784  *  ClearVariant
 785  *
 786  *  Zeros a variant structure without regard to current contents
 787  */
 788 static void ClearVariant(VARIANTARG *pvarg)
 789 {
 790     pvarg->vt = VT_EMPTY;
 791     pvarg->wReserved1 = 0;
 792     pvarg->wReserved2 = 0;
 793     pvarg->wReserved3 = 0;
 794     pvarg->lVal = 0;
 795 }
 796
 797 /*
 798  *  ReleaseVariant
 799  *
 800  *  Clears a particular variant structure and releases any external objects
 801  *  or memory contained in the variant.  Supports the data types listed above.
 802  */
 803 static void ReleaseVariant(VARIANTARG *pvarg)
 804 {
 805     VARTYPE vt;
 806     VARIANTARG _huge *pvargArray;
 807     LONG lLBound, lUBound, l;
 808
 809     vt = (VARTYPE)(pvarg->vt & 0xfff);        // mask off flags
 810
 811     // check if an array.  If so, free its contents, then the array itself.
 812     if (V_ISARRAY(pvarg))
 813     {
 814         // variant arrays are all this routine currently knows about.  Since a
 815         // variant can contain anything (even other arrays), call ourselves
 816         // recursively.
 817         if (vt == VT_VARIANT)
 818         {
 819             SafeArrayGetLBound(pvarg->parray, 1, &lLBound);
 820             SafeArrayGetUBound(pvarg->parray, 1, &lUBound);
 821
 822             if (lUBound > lLBound)
 823             {
 824                 lUBound -= lLBound;
 825
 826                 SafeArrayAccessData(pvarg->parray, (void**)&pvargArray);
 827
 828                 for (l = 0; l < lUBound; l++)
 829                 {
 830                     ReleaseVariant(pvargArray);
 831                     pvargArray++;
 832                 }
 833
 834                 SafeArrayUnaccessData(pvarg->parray);
 835             }
 836         }
 837         else
 838         {
 839             wxLogWarning(wxT("ReleaseVariant: Array contains non-variant type"));
 840         }
 841
 842         // Free the array itself.
 843         SafeArrayDestroy(pvarg->parray);
 844     }
 845     else
 846     {
 847         switch (vt)
 848         {
 849             case VT_DISPATCH:
 850                 if (pvarg->pdispVal)
 851                     pvarg->pdispVal->Release();
 852                 break;
 853
 854             case VT_BSTR:
 855                 SysFreeString(pvarg->bstrVal);
 856                 break;
 857
 858             case VT_I2:
 859             case VT_I4:
 860             case VT_BOOL:
 861             case VT_R8:
 862             case VT_ERROR:        // to avoid erroring on an error return from Excel
 863             case VT_EMPTY:
 864                 // no work for these types
 865                 break;
 866
 867             default:
 868                 wxLogWarning(wxT("ReleaseVariant: Unknown type"));
 869                 break;
 870         }
 871     }
 872
 873     ClearVariant(pvarg);
 874 }
 875
 876 #if 0
 877
 878 void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr)
 879 {
 880     TCHAR szBuf[512];
 881
 882     switch (GetScode(hr))
 883     {
 884         case DISP_E_UNKNOWNNAME:
 885             wsprintf(szBuf, L"%s: Unknown name or named argument.", szMember);
 886             break;
 887
 888         case DISP_E_BADPARAMCOUNT:
 889             wsprintf(szBuf, L"%s: Incorrect number of arguments.", szMember);
 890             break;
 891
 892         case DISP_E_EXCEPTION:
 893             wsprintf(szBuf, L"%s: Error %d: ", szMember, pexcep->wCode);
 894             if (pexcep->bstrDescription != NULL)
 895                 lstrcat(szBuf, pexcep->bstrDescription);
 896             else
 897                 lstrcat(szBuf, L"<<No Description>>");
 898             break;
 899
 900         case DISP_E_MEMBERNOTFOUND:
 901             wsprintf(szBuf, L"%s: method or property not found.", szMember);
 902             break;
 903
 904         case DISP_E_OVERFLOW:
 905             wsprintf(szBuf, L"%s: Overflow while coercing argument values.", szMember);
 906             break;
 907
 908         case DISP_E_NONAMEDARGS:
 909             wsprintf(szBuf, L"%s: Object implementation does not support named arguments.",
 910                         szMember);
 911             break;
 912
 913         case DISP_E_UNKNOWNLCID:
 914             wsprintf(szBuf, L"%s: The locale ID is unknown.", szMember);
 915             break;
 916
 917         case DISP_E_PARAMNOTOPTIONAL:
 918             wsprintf(szBuf, L"%s: Missing a required parameter.", szMember);
 919             break;
 920
 921         case DISP_E_PARAMNOTFOUND:
 922             wsprintf(szBuf, L"%s: Argument not found, argument %d.", szMember, uiArgErr);
 923             break;
 924
 925         case DISP_E_TYPEMISMATCH:
 926             wsprintf(szBuf, L"%s: Type mismatch, argument %d.", szMember, uiArgErr);
 927             break;
 928
 929         default:
 930             wsprintf(szBuf, L"%s: Unknown error occurred.", szMember);
 931             break;
 932     }
 933
 934     wxLogWarning(szBuf);
 935 }
 936
 937 #endif
 938
 939 #endif // wxUSE_OLE_AUTOMATION