class WIN32OLE::Method - Documentation for Ruby 3.3

# class WIN32OLE::Method

### Public Class Methods

new(ole_type, method) → WIN32OLE_METHOD object click to toggle source

Returns a new WIN32OLE_METHOD object which represents the information about OLE method. The first argument ole_type specifies WIN32OLE_TYPE object. The second argument method specifies OLE method name defined OLE class which represents WIN32OLE_TYPE object.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')

    static VALUE
    folemethod_initialize(VALUE self, VALUE oletype, VALUE method)
    {
        VALUE obj = Qnil;
        ITypeInfo *pTypeInfo;
        if (rb_obj_is_kind_of(oletype, cWIN32OLE_TYPE)) {
            SafeStringValue(method);
            pTypeInfo = itypeinfo(oletype);
            obj = olemethod_from_typeinfo(self, pTypeInfo, method);
            if (obj == Qnil) {
                rb_raise(eWIN32OLERuntimeError, "not found %s",
                         StringValuePtr(method));
            }
        }
        else {
            rb_raise(rb_eTypeError, "1st argument should be WIN32OLE_TYPE object");
        }
        return obj;
    }

### Public Instance Methods

WIN32OLE_METHOD#dispid click to toggle source

Returns dispatch ID.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.dispid # => 181

    static VALUE
    folemethod_dispid(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_dispid(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#event? click to toggle source

Returns true if the method is event.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
    puts method.event? # => true

    static VALUE
    folemethod_event(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        if (!pmethod->pOwnerTypeInfo)
            return Qfalse;
        return ole_method_event(pmethod->pOwnerTypeInfo,
                                pmethod->index,
                                rb_ivar_get(self, rb_intern("name")));
    }

WIN32OLE_METHOD#event_interface click to toggle source

Returns event interface name if the method is event.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
    puts method.event_interface # =>  WorkbookEvents

    static VALUE
    folemethod_event_interface(VALUE self)
    {
        BSTR name;
        struct olemethoddata *pmethod;
        HRESULT hr;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        if(folemethod_event(self) == Qtrue) {
            hr = ole_docinfo_from_type(pmethod->pTypeInfo, &name, NULL, NULL, NULL);
            if(SUCCEEDED(hr))
                return WC2VSTR(name);
        }
        return Qnil;
    }

WIN32OLE_METHOD#helpcontext click to toggle source

Returns help context.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.helpcontext # => 65717

    static VALUE
    folemethod_helpcontext(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_helpcontext(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#helpfile click to toggle source

Returns help file. If help file is not found, then the method returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.helpfile # => C:\...\VBAXL9.CHM

    static VALUE
    folemethod_helpfile(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);

        return ole_method_helpfile(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#helpstring click to toggle source

Returns help string of OLE method. If the help string is not found, then the method returns nil.

    tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
    method = WIN32OLE_METHOD.new(tobj, 'Navigate')
    puts method.helpstring # => Navigates to a URL or file.

    static VALUE
    folemethod_helpstring(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_helpstring(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#inspect → String click to toggle source

Returns the method name with class name.

    static VALUE
    folemethod_inspect(VALUE self)
    {
        return default_inspect(self, "WIN32OLE_METHOD");
    }

WIN32OLE_METHOD#invkind click to toggle source

Returns the method invoke kind.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.invkind # => 1

    static VALUE
    folemethod_invkind(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_invkind(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#invoke_kind click to toggle source

Returns the method kind string. The string is “UNKNOWN” or “PROPERTY” or “PROPERTY” or “PROPERTYGET” or “PROPERTYPUT” or “PROPERTYPPUTREF” or “FUNC”.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.invoke_kind # => "FUNC"

    static VALUE
    folemethod_invoke_kind(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_invoke_kind(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#name click to toggle source

Returns the name of the method.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
    puts method.name # => SaveAs

    static VALUE
    folemethod_name(VALUE self)
    {
        return rb_ivar_get(self, rb_intern("name"));
    }

Also aliased as: to_s
WIN32OLE_METHOD#offset_vtbl click to toggle source

Returns the offset ov VTBL.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.offset_vtbl # => 40

    static VALUE
    folemethod_offset_vtbl(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_offset_vtbl(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#params click to toggle source

returns array of WIN32OLE_PARAM object corresponding with method parameters.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
    p method.params # => [Filename, FileFormat, Password, WriteResPassword,
                          ReadOnlyRecommended, CreateBackup, AccessMode,
                          ConflictResolution, AddToMru, TextCodepage,
                          TextVisualLayout]

    static VALUE
    folemethod_params(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_params(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#return_type click to toggle source

Returns string of return value type of method.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.return_type # => Workbook

    static VALUE
    folemethod_return_type(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_return_type(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#return_type_detail click to toggle source

Returns detail information of return value type of method. The information is array.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    p method.return_type_detail # => ["PTR", "USERDEFINED", "Workbook"]

    static VALUE
    folemethod_return_type_detail(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_return_type_detail(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#return_vtype click to toggle source

Returns number of return value type of method.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.return_vtype # => 26

    static VALUE
    folemethod_return_vtype(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_return_vtype(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#size_opt_params click to toggle source

Returns the size of optional parameters.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
    puts method.size_opt_params # => 4

    static VALUE
    folemethod_size_opt_params(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_size_opt_params(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#size_params click to toggle source

Returns the size of arguments of the method.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
    puts method.size_params # => 11

    static VALUE
    folemethod_size_params(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_size_params(pmethod->pTypeInfo, pmethod->index);
    }

WIN32OLE_METHOD#name

Returns the name of the method.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
    method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
    puts method.name # => SaveAs

Alias for: name
WIN32OLE_METHOD#visible? click to toggle source

Returns true if the method is public.

    tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbooks')
    method = WIN32OLE_METHOD.new(tobj, 'Add')
    puts method.visible? # => true

    static VALUE
    folemethod_visible(VALUE self)
    {
        struct olemethoddata *pmethod;
        TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
        return ole_method_visible(pmethod->pTypeInfo, pmethod->index);
    }