class WIN32OLE - Documentation for Ruby 3.2

# class WIN32OLE

`WIN32OLE`

`WIN32OLE` objects represent OLE Automation object in Ruby.

By using `WIN32OLE`, you can access OLE server like VBScript.

Here is sample script.

    require 'win32ole'

    excel = WIN32OLE.new('Excel.Application')
    excel.visible = true
    workbook = excel.Workbooks.Add();
    worksheet = workbook.Worksheets(1);
    worksheet.Range("A1:D1").value = ["North","South","East","West"];
    worksheet.Range("A2:B2").value = [5.2, 10];
    worksheet.Range("C2").value = 8;
    worksheet.Range("D2").value = 20;

    range = worksheet.Range("A1:D2");
    range.select
    chart = workbook.Charts.Add;

    workbook.saved = true;

    excel.ActiveWorkbook.Close(0);
    excel.Quit();

Unfortunately, Win32OLE doesn’t support the argument passed by reference directly. Instead, Win32OLE provides `WIN32OLE::ARGV` or WIN32OLE_VARIANT object. If you want to get the result value of argument passed by reference, you can use `WIN32OLE::ARGV` or WIN32OLE_VARIANT.

    oleobj.method(arg1, arg2, refargv3)
    puts WIN32OLE::ARGV[2]   # the value of refargv3 after called oleobj.method

or

    refargv3 = WIN32OLE_VARIANT.new(XXX,
                WIN32OLE::VARIANT::VT_BYREF|WIN32OLE::VARIANT::VT_XXX)
    oleobj.method(arg1, arg2, refargv3)
    p refargv3.value # the value of refargv3 after called oleobj.method.

### Constants

ARGV

  After invoking OLE methods with reference arguments, you can access the value of arguments by using `ARGV`.

  If the method of OLE(COM) server written by C#.NET is following:

      void calcsum(int a, int b, out int c) {
          c = a + b;
      }

  then, the Ruby OLE(COM) client script to retrieve the value of argument c after invoking calcsum method is following:

      a = 10
      b = 20
      c = 0
      comserver.calcsum(a, b, c)
      p c # => 0
      p WIN32OLE::ARGV # => [10, 20, 30]

  You can use WIN32OLE_VARIANT object to retrieve the value of reference arguments instead of referring `WIN32OLE::ARGV`.

CP_ACP

  ANSI code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

CP_MACCP

  2

CP_OEMCP

  OEM code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

CP_SYMBOL

  symbol code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

CP_THREAD_ACP

  current thread ANSI code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

CP_UTF7

  UTF-7 code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

CP_UTF8

  UTF-8 code page. See `WIN32OLE.codepage` and `WIN32OLE.codepage=`.

LOCALE_SYSTEM_DEFAULT

  default locale for the operating system. See `WIN32OLE.locale` and `WIN32OLE.locale=`.

LOCALE_USER_DEFAULT

  default locale for the user or process. See `WIN32OLE.locale` and `WIN32OLE.locale=`.

VERSION

  Version string of `WIN32OLE`.

### Public Class Methods

codepage click to toggle source

Returns current codepage.

    WIN32OLE.codepage # => WIN32OLE::CP_ACP

    static VALUE
    fole_s_get_code_page(VALUE self)
    {
        return RB_INT2FIX(cWIN32OLE_cp);
    }

codepage = CP click to toggle source

Sets current codepage. The `WIN32OLE.codepage` is initialized according to `Encoding.default_internal`. If `Encoding.default_internal` is nil then `WIN32OLE.codepage` is initialized according to `Encoding.default_external`.

    WIN32OLE.codepage = WIN32OLE::CP_UTF8
    WIN32OLE.codepage = 65001

    static VALUE
    fole_s_set_code_page(VALUE self, VALUE vcp)
    {
        UINT cp = RB_FIX2INT(vcp);
        set_ole_codepage(cp);
        /*
         * Should this method return old codepage?
         */
        return Qnil;
    }

connect( ole ) -→ aWIN32OLE click to toggle source

Returns running OLE Automation object or `WIN32OLE` object from moniker. 1st argument should be OLE program id or class id or moniker.

    WIN32OLE.connect('Excel.Application') # => WIN32OLE object which represents running Excel.

    static VALUE
    fole_s_connect(int argc, VALUE *argv, VALUE self)
    {
        VALUE svr_name;
        VALUE others;
        HRESULT hr;
        CLSID   clsid;
        OLECHAR *pBuf;
        IDispatch *pDispatch;
        void *p;
        IUnknown *pUnknown;

        /* initialize to use OLE */
        ole_initialize();

        rb_scan_args(argc, argv, "1*", &svr_name, &others);
        StringValue(svr_name);

        /* get CLSID from OLE server name */
        pBuf = ole_vstr2wc(svr_name);
        hr = CLSIDFromProgID(pBuf, &clsid);
        if(FAILED(hr)) {
            hr = CLSIDFromString(pBuf, &clsid);
        }
        SysFreeString(pBuf);
        if(FAILED(hr)) {
            return ole_bind_obj(svr_name, argc, argv, self);
        }

        hr = GetActiveObject(&clsid, 0, &pUnknown);
        if (FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError,
                      "OLE server `%s' not running", StringValuePtr(svr_name));
        }
        hr = pUnknown->lpVtbl->QueryInterface(pUnknown, &IID_IDispatch, &p);
        pDispatch = p;
        if(FAILED(hr)) {
            OLE_RELEASE(pUnknown);
            ole_raise(hr, eWIN32OLERuntimeError,
                      "failed to create WIN32OLE server `%s'",
                      StringValuePtr(svr_name));
        }

        OLE_RELEASE(pUnknown);

        return create_win32ole_object(self, pDispatch, argc, argv);
    }

const_load( ole, mod = WIN32OLE) click to toggle source

Defines the constants of OLE Automation server as mod’s constants. The first argument is `WIN32OLE` object or type library name. If 2nd argument is omitted, the default is `WIN32OLE`. The first letter of Ruby’s constant variable name is upper case, so constant variable name of `WIN32OLE` object is capitalized. For example, the ‘xlTop’ constant of Excel is changed to ‘XlTop’ in `WIN32OLE`. If the first letter of constant variable is not [A-Z], then the constant is defined as CONSTANTS hash element.

    module EXCEL_CONST
    end
    excel = WIN32OLE.new('Excel.Application')
    WIN32OLE.const_load(excel, EXCEL_CONST)
    puts EXCEL_CONST::XlTop # => -4160
    puts EXCEL_CONST::CONSTANTS['_xlDialogChartSourceData'] # => 541

    WIN32OLE.const_load(excel)
    puts WIN32OLE::XlTop # => -4160

    module MSO
    end
    WIN32OLE.const_load('Microsoft Office 9.0 Object Library', MSO)
    puts MSO::MsoLineSingle # => 1

    static VALUE
    fole_s_const_load(int argc, VALUE *argv, VALUE self)
    {
        VALUE ole;
        VALUE klass;
        struct oledata *pole = NULL;
        ITypeInfo *pTypeInfo;
        ITypeLib *pTypeLib;
        unsigned int index;
        HRESULT hr;
        OLECHAR *pBuf;
        VALUE file;
        LCID    lcid = cWIN32OLE_lcid;

        rb_scan_args(argc, argv, "11", &ole, &klass);
        if (!RB_TYPE_P(klass, T_CLASS) &&
            !RB_TYPE_P(klass, T_MODULE) &&
            !RB_TYPE_P(klass, T_NIL)) {
            rb_raise(rb_eTypeError, "2nd parameter must be Class or Module");
        }
        if (rb_obj_is_kind_of(ole, cWIN32OLE)) {
            pole = oledata_get_struct(ole);
            hr = pole->pDispatch->lpVtbl->GetTypeInfo(pole->pDispatch,
                                                      0, lcid, &pTypeInfo);
            if(FAILED(hr)) {
                ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to GetTypeInfo");
            }
            hr = pTypeInfo->lpVtbl->GetContainingTypeLib(pTypeInfo, &pTypeLib, &index);
            if(FAILED(hr)) {
                OLE_RELEASE(pTypeInfo);
                ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to GetContainingTypeLib");
            }
            OLE_RELEASE(pTypeInfo);
            if(!RB_TYPE_P(klass, T_NIL)) {
                ole_const_load(pTypeLib, klass, self);
            }
            else {
                ole_const_load(pTypeLib, cWIN32OLE, self);
            }
            OLE_RELEASE(pTypeLib);
        }
        else if(RB_TYPE_P(ole, T_STRING)) {
            file = typelib_file(ole);
            if (file == Qnil) {
                file = ole;
            }
            pBuf = ole_vstr2wc(file);
            hr = LoadTypeLibEx(pBuf, REGKIND_NONE, &pTypeLib);
            SysFreeString(pBuf);
            if (FAILED(hr))
              ole_raise(hr, eWIN32OLERuntimeError, "failed to LoadTypeLibEx");
            if(!RB_TYPE_P(klass, T_NIL)) {
                ole_const_load(pTypeLib, klass, self);
            }
            else {
                ole_const_load(pTypeLib, cWIN32OLE, self);
            }
            OLE_RELEASE(pTypeLib);
        }
        else {
            rb_raise(rb_eTypeError, "1st parameter must be WIN32OLE instance");
        }
        return Qnil;
    }

create_guid click to toggle source

Creates GUID.

    WIN32OLE.create_guid # => {1CB530F1-F6B1-404D-BCE6-1959BF91F4A8}

    static VALUE
    fole_s_create_guid(VALUE self)
    {
        GUID guid;
        HRESULT hr;
        OLECHAR bstr[80];
        int len = 0;
        hr = CoCreateGuid(&guid);
        if (FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError, "failed to create GUID");
        }
        len = StringFromGUID2(&guid, bstr, sizeof(bstr)/sizeof(OLECHAR));
        if (len == 0) {
            rb_raise(rb_eRuntimeError, "failed to create GUID(buffer over)");
        }
        return ole_wc2vstr(bstr, FALSE);
    }

locale → locale id. click to toggle source

Returns current locale id (lcid). The default locale is `WIN32OLE::LOCALE_SYSTEM_DEFAULT`.

    lcid = WIN32OLE.locale

    static VALUE
    fole_s_get_locale(VALUE self)
    {
        return RB_INT2FIX(cWIN32OLE_lcid);
    }

locale = lcid click to toggle source

Sets current locale id (lcid).

    WIN32OLE.locale = 1033 # set locale English(U.S)
    obj = WIN32OLE_VARIANT.new("$100,000", WIN32OLE::VARIANT::VT_CY)

    static VALUE
    fole_s_set_locale(VALUE self, VALUE vlcid)
    {
        LCID lcid = RB_FIX2INT(vlcid);
        if (lcid_installed(lcid)) {
            cWIN32OLE_lcid = lcid;
        } else {
            switch (lcid) {
            case LOCALE_SYSTEM_DEFAULT:
            case LOCALE_USER_DEFAULT:
                cWIN32OLE_lcid = lcid;
                break;
            default:
                rb_raise(eWIN32OLERuntimeError, "not installed locale: %u", (unsigned int)lcid);
            }
        }
        return Qnil;
    }

new(server, [host]) → WIN32OLE object click to toggle source
new(server, license: 'key') → WIN32OLE object

Returns a new `WIN32OLE` object(OLE Automation object). The first argument server specifies OLE Automation server. The first argument should be CLSID or PROGID. If second argument host specified, then returns OLE Automation object on host. If :license keyword argument is provided, IClassFactory2::CreateInstanceLic is used to create instance of licensed server.

    WIN32OLE.new('Excel.Application') # => Excel OLE Automation WIN32OLE object.
    WIN32OLE.new('{00024500-0000-0000-C000-000000000046}') # => Excel OLE Automation WIN32OLE object.

    static VALUE
    fole_initialize(int argc, VALUE *argv, VALUE self)
    {
        VALUE svr_name;
        VALUE host;
        VALUE others;
        VALUE opts;
        HRESULT hr;
        CLSID   clsid;
        OLECHAR *pBuf;
        OLECHAR *key_buf;
        IDispatch *pDispatch;
        IClassFactory2 * pIClassFactory2;
        void *p;
        static ID keyword_ids[1];
        VALUE kwargs[1];

        rb_call_super(0, 0);
        rb_scan_args(argc, argv, "11*:", &svr_name, &host, &others, &opts);

        StringValue(svr_name);
        if (!NIL_P(host)) {
            StringValue(host);
            return ole_create_dcom(self, svr_name, host, others);
        }

        /* get CLSID from OLE server name */
        pBuf  = ole_vstr2wc(svr_name);
        hr = CLSIDFromProgID(pBuf, &clsid);
        if(FAILED(hr)) {
            hr = CLSIDFromString(pBuf, &clsid);
        }
        SysFreeString(pBuf);
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError,
                      "unknown OLE server: `%s'",
                      StringValuePtr(svr_name));
        }

        if (!keyword_ids[0]) {
            keyword_ids[0] = rb_intern_const("license");
        }
        rb_get_kwargs(opts, keyword_ids, 0, 1, kwargs);

        if (kwargs[0] == Qundef) {
            /* get IDispatch interface */
            hr = CoCreateInstance(
                &clsid,
                NULL,
                CLSCTX_INPROC_SERVER | CLSCTX_LOCAL_SERVER,
                &IID_IDispatch,
                &p
            );
        } else {
            hr = CoGetClassObject(
                &clsid,
                CLSCTX_INPROC_SERVER | CLSCTX_LOCAL_SERVER,
                NULL,
                &IID_IClassFactory2,
                (LPVOID)&pIClassFactory2
            );
            if (hr == S_OK) {
                key_buf = ole_vstr2wc(kwargs[0]);
                hr = pIClassFactory2->lpVtbl->CreateInstanceLic(pIClassFactory2, NULL, NULL, &IID_IDispatch, key_buf, &p);
                SysFreeString(key_buf);
                OLE_RELEASE(pIClassFactory2);
            }
        }
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError,
                      "failed to create WIN32OLE object from `%s'",
                      StringValuePtr(svr_name));
        }
        pDispatch = p;

        ole_set_member(self, pDispatch);
        return self;
    }

ole_free(aWIN32OLE) -→ number click to toggle source

Invokes Release method of Dispatch interface of `WIN32OLE` object. You should not use this method because this method exists only for debugging `WIN32OLE`. The return value is reference counter of OLE object.

    static VALUE
    fole_s_free(VALUE self, VALUE obj)
    {
        ULONG n = 0;
        struct oledata * pole = NULL;
        pole = oledata_get_struct(obj);
        if(pole->pDispatch) {
            if (reference_count(pole) > 0) {
                n = OLE_RELEASE(pole->pDispatch);
            }
        }
        return RB_INT2NUM(n);
    }

ole_reference_count(aWIN32OLE) -→ number click to toggle source

Returns reference counter of Dispatch interface of `WIN32OLE` object. You should not use this method because this method exists only for debugging `WIN32OLE`.

    static VALUE
    fole_s_reference_count(VALUE self, VALUE obj)
    {
        struct oledata * pole = NULL;
        pole = oledata_get_struct(obj);
        return RB_INT2NUM(reference_count(pole));
    }

ole_show_help(obj [,helpcontext]) click to toggle source

Displays helpfile. The 1st argument specifies WIN32OLE_TYPE object or WIN32OLE_METHOD object or helpfile.

    excel = WIN32OLE.new('Excel.Application')
    typeobj = excel.ole_type
    WIN32OLE.ole_show_help(typeobj)

    static VALUE
    fole_s_show_help(int argc, VALUE *argv, VALUE self)
    {
        VALUE target;
        VALUE helpcontext;
        VALUE helpfile;
        VALUE name;
        HWND  hwnd;
        rb_scan_args(argc, argv, "11", &target, &helpcontext);
        if (rb_obj_is_kind_of(target, cWIN32OLE_TYPE) ||
            rb_obj_is_kind_of(target, cWIN32OLE_METHOD)) {
            helpfile = rb_funcall(target, rb_intern("helpfile"), 0);
            if(strlen(StringValuePtr(helpfile)) == 0) {
                name = rb_ivar_get(target, rb_intern("name"));
                rb_raise(rb_eRuntimeError, "no helpfile of `%s'",
                         StringValuePtr(name));
            }
            helpcontext = rb_funcall(target, rb_intern("helpcontext"), 0);
        } else {
            helpfile = target;
        }
        if (!RB_TYPE_P(helpfile, T_STRING)) {
            rb_raise(rb_eTypeError, "1st parameter must be (String|WIN32OLE_TYPE|WIN32OLE_METHOD)");
        }
        hwnd = ole_show_help(helpfile, helpcontext);
        if(hwnd == 0) {
            rb_raise(rb_eRuntimeError, "failed to open help file `%s'",
                     StringValuePtr(helpfile));
        }
        return Qnil;
    }

### Public Instance Methods

WIN32OLE[a1,a2,...] click to toggle source

Returns the value of Collection specified by a1, a2,.…

    dict = WIN32OLE.new('Scripting.Dictionary')
    dict.add('ruby', 'Ruby')
    puts dict['ruby'] # => 'Ruby' (same as `puts dict.item('ruby')')

Remark: You can not use this method to get the property.

    excel = WIN32OLE.new('Excel.Application')
    # puts excel['Visible']  This is error !!!
    puts excel.Visible # You should to use this style to get the property.

    static VALUE
    fole_getproperty_with_bracket(int argc, VALUE *argv, VALUE self)
    {
        VALUE v = ole_invoke(argc, argv, self, DISPATCH_PROPERTYGET, TRUE);
        if (v == rb_eNoMethodError) {
            return rb_call_super(argc, argv);
        }
        return v;
    }

WIN32OLE[a1, a2, ...]=val click to toggle source

Sets the value to `WIN32OLE` object specified by a1, a2, …

    dict = WIN32OLE.new('Scripting.Dictionary')
    dict.add('ruby', 'RUBY')
    dict['ruby'] = 'Ruby'
    puts dict['ruby'] # => 'Ruby'

Remark: You can not use this method to set the property value.

    excel = WIN32OLE.new('Excel.Application')
    # excel['Visible'] = true # This is error !!!
    excel.Visible = true # You should to use this style to set the property.

    static VALUE
    fole_setproperty_with_bracket(int argc, VALUE *argv, VALUE self)
    {
        VALUE v = ole_invoke(argc, argv, self, DISPATCH_PROPERTYPUT, TRUE);
        if (v == rb_eNoMethodError) {
            return rb_call_super(argc, argv);
        }
        return v;
    }

WIN32OLE#_getproperty(dispid, args, types) click to toggle source

Runs the early binding method to get property. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.

    excel = WIN32OLE.new('Excel.Application')
    puts excel._getproperty(558, [], []) # same effect as puts excel.visible

    static VALUE
    fole_getproperty2(VALUE self, VALUE dispid, VALUE args, VALUE types)
    {
        return ole_invoke2(self, dispid, args, types, DISPATCH_PROPERTYGET);
    }

WIN32OLE#_invoke(dispid, args, types) click to toggle source

Runs the early binding method. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.

    excel = WIN32OLE.new('Excel.Application')
    excel._invoke(302, [], []) #  same effect as excel.Quit

    static VALUE
    fole_invoke2(VALUE self, VALUE dispid, VALUE args, VALUE types)
    {
        return ole_invoke2(self, dispid, args, types, DISPATCH_METHOD);
    }

WIN32OLE#_setproperty(dispid, args, types) click to toggle source

Runs the early binding method to set property. The 1st argument specifies dispatch ID, the 2nd argument specifies the array of arguments, the 3rd argument specifies the array of the type of arguments.

    excel = WIN32OLE.new('Excel.Application')
    excel._setproperty(558, [true], [WIN32OLE::VARIANT::VT_BOOL]) # same effect as excel.visible = true

    static VALUE
    fole_setproperty2(VALUE self, VALUE dispid, VALUE args, VALUE types)
    {
        return ole_invoke2(self, dispid, args, types, DISPATCH_PROPERTYPUT);
    }

WIN32OLE#each {|i|...} click to toggle source

Iterates over each item of OLE collection which has IEnumVARIANT interface.

    excel = WIN32OLE.new('Excel.Application')
    book = excel.workbooks.add
    sheets = book.worksheets(1)
    cells = sheets.cells("A1:A5")
    cells.each do |cell|
      cell.value = 10
    end

    static VALUE
    fole_each(VALUE self)
    {
        LCID    lcid = cWIN32OLE_lcid;

        struct oledata *pole = NULL;

        unsigned int argErr;
        EXCEPINFO excepinfo;
        DISPPARAMS dispParams;
        VARIANT result;
        HRESULT hr;
        IEnumVARIANT *pEnum = NULL;
        void *p;

        RETURN_ENUMERATOR(self, 0, 0);

        VariantInit(&result);
        dispParams.rgvarg = NULL;
        dispParams.rgdispidNamedArgs = NULL;
        dispParams.cNamedArgs = 0;
        dispParams.cArgs = 0;
        memset(&excepinfo, 0, sizeof(excepinfo));

        pole = oledata_get_struct(self);
        hr = pole->pDispatch->lpVtbl->Invoke(pole->pDispatch, DISPID_NEWENUM,
                                             &IID_NULL, lcid,
                                             DISPATCH_METHOD | DISPATCH_PROPERTYGET,
                                             &dispParams, &result,
                                             &excepinfo, &argErr);

        if (FAILED(hr)) {
            VariantClear(&result);
            ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to get IEnum Interface");
        }

        if (V_VT(&result) == VT_UNKNOWN) {
            hr = V_UNKNOWN(&result)->lpVtbl->QueryInterface(V_UNKNOWN(&result),
                                                            &IID_IEnumVARIANT,
                                                            &p);
            pEnum = p;
        } else if (V_VT(&result) == VT_DISPATCH) {
            hr = V_DISPATCH(&result)->lpVtbl->QueryInterface(V_DISPATCH(&result),
                                                             &IID_IEnumVARIANT,
                                                             &p);
            pEnum = p;
        }
        if (FAILED(hr) || !pEnum) {
            VariantClear(&result);
            ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to get IEnum Interface");
        }

        VariantClear(&result);
        rb_ensure(ole_each_sub, (VALUE)pEnum, ole_ienum_free, (VALUE)pEnum);
        return Qnil;
    }

WIN32OLE#invoke(method, [arg1,...]) → return value of method. click to toggle source

Runs OLE method. The first argument specifies the method name of OLE Automation object. The others specify argument of the method. If you can not execute method directly, then use this method instead.

    excel = WIN32OLE.new('Excel.Application')
    excel.invoke('Quit')  # => same as excel.Quit

    static VALUE
    fole_invoke(int argc, VALUE *argv, VALUE self)
    {
        VALUE v = ole_invoke(argc, argv, self, DISPATCH_METHOD|DISPATCH_PROPERTYGET, FALSE);
        if (v == rb_eNoMethodError) {
            return rb_call_super(argc, argv);
        }
        return v;
    }

WIN32OLE#method_missing(id [,arg1, arg2, ...]) click to toggle source

Calls `WIN32OLE#invoke` method.

    static VALUE
    fole_missing(int argc, VALUE *argv, VALUE self)
    {
        VALUE mid, org_mid, sym, v;
        const char* mname;
        long n;
        rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
        mid = org_mid = argv[0];
        sym = rb_check_symbol(&mid);
        if (!NIL_P(sym)) mid = rb_sym2str(sym);
        mname = StringValueCStr(mid);
        if(!mname) {
            rb_raise(rb_eRuntimeError, "fail: unknown method or property");
        }
        n = RSTRING_LEN(mid);
        if(mname[n-1] == '=') {
            rb_check_arity(argc, 2, 2);
            argv[0] = rb_enc_associate(rb_str_subseq(mid, 0, n-1), cWIN32OLE_enc);

            return ole_propertyput(self, argv[0], argv[1]);
        }
        else {
            argv[0] = rb_enc_associate(rb_str_dup(mid), cWIN32OLE_enc);
            v = ole_invoke(argc, argv, self, DISPATCH_METHOD|DISPATCH_PROPERTYGET, FALSE);
            if (v == rb_eNoMethodError) {
                argv[0] = org_mid;
                return rb_call_super(argc, argv);
            }
            return v;
        }
    }

methods(*args) click to toggle source

By overriding `Object#methods`, `WIN32OLE` might work well with did_you_mean gem. This is experimental.

    require 'win32ole'
    dict = WIN32OLE.new('Scripting.Dictionary')
    dict.Ade('a', 1)
    #=> Did you mean?  Add

Calls superclass method `Object#methods`

    # File ext/win32ole/lib/win32ole.rb, line 21
    def methods(*args)
      super + ole_methods_safely.map(&:name).map(&:to_sym)
    end

WIN32OLE#ole_activex_initialize() → Qnil click to toggle source

Initialize `WIN32OLE` object(ActiveX Control) by calling IPersistMemory::InitNew.

Before calling OLE method, some kind of the ActiveX controls created with MFC should be initialized by calling IPersistXXX::InitNew.

If and only if you received the exception “HRESULT error code: 0x8000ffff catastrophic failure”, try this method before invoking any ole_method.

    obj = WIN32OLE.new("ProgID_or_GUID_of_ActiveX_Control")
    obj.ole_activex_initialize
    obj.method(...)

    static VALUE
    fole_activex_initialize(VALUE self)
    {
        struct oledata *pole = NULL;
        IPersistMemory *pPersistMemory;
        void *p;

        HRESULT hr = S_OK;

        pole = oledata_get_struct(self);

        hr = pole->pDispatch->lpVtbl->QueryInterface(pole->pDispatch, &IID_IPersistMemory, &p);
        pPersistMemory = p;
        if (SUCCEEDED(hr)) {
            hr = pPersistMemory->lpVtbl->InitNew(pPersistMemory);
            OLE_RELEASE(pPersistMemory);
            if (SUCCEEDED(hr)) {
                return Qnil;
            }
        }

        if (FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError, "fail to initialize ActiveX control");
        }

        return Qnil;
    }

WIN32OLE#ole_free click to toggle source

invokes Release method of Dispatch interface of `WIN32OLE` object. Usually, you do not need to call this method because Release method called automatically when `WIN32OLE` object garbaged.

    static VALUE
    fole_free(VALUE self)
    {
        struct oledata *pole = NULL;
        pole = oledata_get_struct(self);
        OLE_FREE(pole->pDispatch);
        pole->pDispatch = NULL;
        return Qnil;
    }

WIN32OLE#ole_func_methods click to toggle source

Returns the array of WIN32OLE_METHOD object . The element of the array is property (settable) of `WIN32OLE` object.

    excel = WIN32OLE.new('Excel.Application')
    properties = excel.ole_func_methods

    static VALUE
    fole_func_methods(VALUE self)
    {
        return ole_methods( self, INVOKE_FUNC);
    }

WIN32OLE#ole_get_methods click to toggle source

Returns the array of WIN32OLE_METHOD object . The element of the array is property (gettable) of `WIN32OLE` object.

    excel = WIN32OLE.new('Excel.Application')
    properties = excel.ole_get_methods

    static VALUE
    fole_get_methods(VALUE self)
    {
        return ole_methods( self, INVOKE_PROPERTYGET);
    }

WIN32OLE#ole_method_help(method) click to toggle source

Returns WIN32OLE_METHOD object corresponding with method specified by 1st argument.

    excel = WIN32OLE.new('Excel.Application')
    method = excel.ole_method_help('Quit')

    static VALUE
    fole_method_help(VALUE self, VALUE cmdname)
    {
        ITypeInfo *pTypeInfo;
        HRESULT hr;
        struct oledata *pole = NULL;
        VALUE obj;

        SafeStringValue(cmdname);
        pole = oledata_get_struct(self);
        hr = typeinfo_from_ole(pole, &pTypeInfo);
        if(FAILED(hr))
            ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to get ITypeInfo");

        obj = create_win32ole_method(pTypeInfo, cmdname);

        OLE_RELEASE(pTypeInfo);
        if (obj == Qnil)
            rb_raise(eWIN32OLERuntimeError, "not found %s",
                     StringValuePtr(cmdname));
        return obj;
    }

Also aliased as: ole_method_help
WIN32OLE#ole_method_help(method)

Returns WIN32OLE_METHOD object corresponding with method specified by 1st argument.

    excel = WIN32OLE.new('Excel.Application')
    method = excel.ole_method_help('Quit')

Alias for: ole_method
WIN32OLE#ole_methods click to toggle source

Returns the array of WIN32OLE_METHOD object. The element is OLE method of `WIN32OLE` object.

    excel = WIN32OLE.new('Excel.Application')
    methods = excel.ole_methods

    static VALUE
    fole_methods(VALUE self)
    {
        return ole_methods( self, INVOKE_FUNC | INVOKE_PROPERTYGET | INVOKE_PROPERTYPUT | INVOKE_PROPERTYPUTREF);
    }

WIN32OLE#ole_type

Returns WIN32OLE_TYPE object.

    excel = WIN32OLE.new('Excel.Application')
    tobj = excel.ole_type

Alias for: ole_type
WIN32OLE#ole_put_methods click to toggle source

Returns the array of WIN32OLE_METHOD object . The element of the array is property (settable) of `WIN32OLE` object.

    excel = WIN32OLE.new('Excel.Application')
    properties = excel.ole_put_methods

    static VALUE
    fole_put_methods(VALUE self)
    {
        return ole_methods( self, INVOKE_PROPERTYPUT|INVOKE_PROPERTYPUTREF);
    }

WIN32OLE#ole_query_interface(iid) → WIN32OLE object click to toggle source

Returns `WIN32OLE` object for a specific dispatch or dual interface specified by iid.

    ie = WIN32OLE.new('InternetExplorer.Application')
    ie_web_app = ie.ole_query_interface('{0002DF05-0000-0000-C000-000000000046}') # => WIN32OLE object for dispinterface IWebBrowserApp

    static VALUE
    fole_query_interface(VALUE self, VALUE str_iid)
    {
        HRESULT hr;
        OLECHAR *pBuf;
        IID iid;
        struct oledata *pole = NULL;
        IDispatch *pDispatch;
        void *p;

        pBuf  = ole_vstr2wc(str_iid);
        hr = CLSIDFromString(pBuf, &iid);
        SysFreeString(pBuf);
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLERuntimeError,
                      "invalid iid: `%s'",
                      StringValuePtr(str_iid));
        }

        pole = oledata_get_struct(self);
        if(!pole->pDispatch) {
            rb_raise(rb_eRuntimeError, "failed to get dispatch interface");
        }

        hr = pole->pDispatch->lpVtbl->QueryInterface(pole->pDispatch, &iid,
                                                     &p);
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLEQueryInterfaceError,
                      "failed to get interface `%s'",
                      StringValuePtr(str_iid));
        }

        pDispatch = p;
        return create_win32ole_object(cWIN32OLE, pDispatch, 0, 0);
    }

WIN32OLE#ole_respond_to?(method) → true or false click to toggle source

Returns true when OLE object has OLE method, otherwise returns false.

    ie = WIN32OLE.new('InternetExplorer.Application')
    ie.ole_respond_to?("gohome") => true

    static VALUE
    fole_respond_to(VALUE self, VALUE method)
    {
        struct oledata *pole = NULL;
        BSTR wcmdname;
        DISPID DispID;
        HRESULT hr;
        if(!RB_TYPE_P(method, T_STRING) && !RB_TYPE_P(method, T_SYMBOL)) {
            rb_raise(rb_eTypeError, "wrong argument type (expected String or Symbol)");
        }
        if (RB_TYPE_P(method, T_SYMBOL)) {
            method = rb_sym2str(method);
        }
        pole = oledata_get_struct(self);
        wcmdname = ole_vstr2wc(method);
        hr = pole->pDispatch->lpVtbl->GetIDsOfNames( pole->pDispatch, &IID_NULL,
                &wcmdname, 1, cWIN32OLE_lcid, &DispID);
        SysFreeString(wcmdname);
        return SUCCEEDED(hr) ? Qtrue : Qfalse;
    }

WIN32OLE#ole_type click to toggle source

Returns WIN32OLE_TYPE object.

    excel = WIN32OLE.new('Excel.Application')
    tobj = excel.ole_type

    static VALUE
    fole_type(VALUE self)
    {
        ITypeInfo *pTypeInfo;
        HRESULT hr;
        struct oledata *pole = NULL;
        LCID  lcid = cWIN32OLE_lcid;
        VALUE type = Qnil;

        pole = oledata_get_struct(self);

        hr = pole->pDispatch->lpVtbl->GetTypeInfo( pole->pDispatch, 0, lcid, &pTypeInfo );
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to GetTypeInfo");
        }
        type = ole_type_from_itypeinfo(pTypeInfo);
        OLE_RELEASE(pTypeInfo);
        if (type == Qnil) {
            rb_raise(rb_eRuntimeError, "failed to create WIN32OLE_TYPE obj from ITypeInfo");
        }
        return type;
    }

Also aliased as: ole_obj_help
WIN32OLE#ole_typelib → The WIN32OLE_TYPELIB object click to toggle source

Returns the WIN32OLE_TYPELIB object. The object represents the type library which contains the `WIN32OLE` object.

    excel = WIN32OLE.new('Excel.Application')
    tlib = excel.ole_typelib
    puts tlib.name  # -> 'Microsoft Excel 9.0 Object Library'

    static VALUE
    fole_typelib(VALUE self)
    {
        struct oledata *pole = NULL;
        HRESULT hr;
        ITypeInfo *pTypeInfo;
        LCID  lcid = cWIN32OLE_lcid;
        VALUE vtlib = Qnil;

        pole = oledata_get_struct(self);
        hr = pole->pDispatch->lpVtbl->GetTypeInfo(pole->pDispatch,
                                                  0, lcid, &pTypeInfo);
        if(FAILED(hr)) {
            ole_raise(hr, eWIN32OLEQueryInterfaceError, "failed to GetTypeInfo");
        }
        vtlib = ole_typelib_from_itypeinfo(pTypeInfo);
        OLE_RELEASE(pTypeInfo);
        if (vtlib == Qnil) {
            rb_raise(rb_eRuntimeError, "failed to get type library info.");
        }
        return vtlib;
    }

setproperty('property', [arg1, arg2,...] val) click to toggle source

Sets property of OLE object. When you want to set property with argument, you can use this method.

    excel = WIN32OLE.new('Excel.Application')
    excel.Visible = true
    book = excel.workbooks.add
    sheet = book.worksheets(1)
    sheet.setproperty('Cells', 1, 2, 10) # => The B1 cell value is 10.

    static VALUE
    fole_setproperty(int argc, VALUE *argv, VALUE self)
    {
        VALUE v = ole_invoke(argc, argv, self, DISPATCH_PROPERTYPUT, FALSE);
        if (v == rb_eNoMethodError) {
            return rb_call_super(argc, argv);
        }
        return v;
    }

### Private Instance Methods

ole_methods_safely() click to toggle source

    # File ext/win32ole/lib/win32ole.rb, line 27
    def ole_methods_safely
      ole_methods
    rescue WIN32OLEQueryInterfaceError
      []
    end