Class: WIN32OLE_TYPE

Relationships & Source Files
Inherits:	Object
Defined in:	ext/win32ole/win32ole_type.c, ext/win32ole/win32ole_type.c

Overview

WIN32OLE_TYPE objects represent OLE type library information.

Class Method Summary

.new(typelib, ole_class) ⇒ WIN32OLE_TYPE constructor

Returns a new WIN32OLE_TYPE object.
.ole_classes(typelib)

Returns array of WIN32OLE_TYPE objects defined by the typelib type library.
.progids

Returns array of ProgID.
.typelibs

Returns array of type libraries.

Instance Attribute Summary

#visible?(#=> true or false) readonly

Returns true if the OLE class is public.

Instance Method Summary

#default_event_sources

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FSOURCE and IMPLTYPEFLAG_FDEFAULT.
#default_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FDEFAULT.
#guid(#=> GUID)

Returns GUID.
#helpcontext

Returns helpcontext.
#helpfile

Returns helpfile path.
#helpstring(#=> help string.)

Returns help string.
#implemented_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object.
#inspect ⇒ String

Returns the type name with class name.
#major_version

Returns major version.
#minor_version(#=> OLE minor version)

Returns minor version.
#name(#=> OLE type name)

Alias for #to_s.
#ole_methods(# the array of WIN32OLE_METHOD objects.)

Returns array of ::WIN32OLE_METHOD objects which represent OLE method defined in OLE type library.
#ole_type(#=> OLE type string.)

returns type of OLE class.
#ole_typelib

Returns the ::WIN32OLE_TYPELIB object which is including the WIN32OLE_TYPE object.
#progid(#=> ProgID)

Returns ProgID if it exists.
#source_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FSOURCE.
#src_type(#=> OLE source class)

Returns source class when the OLE class is ‘Alias’.
#to_s(#=> OLE type name) (also: #name)

Returns OLE type name.
#typekind(#=> number of type.)

Returns number which represents type.
#variables

Returns array of ::WIN32OLE_VARIABLE objects which represent variables defined in OLE class.

Constructor Details

.new(typelib, ole_class) ⇒ `WIN32OLE_TYPE`

Returns a new WIN32OLE_TYPE object. The first argument typelib specifies OLE type library name. The second argument specifies OLE class name.

WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
    # => WIN32OLE_TYPE object of Application class of Excel.

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 257


static VALUE
foletype_initialize(VALUE self, VALUE typelib, VALUE oleclass)
{
    VALUE file;
    OLECHAR * pbuf;
    ITypeLib *pTypeLib;
    HRESULT hr;

    SafeStringValue(oleclass);
    SafeStringValue(typelib);
    file = typelib_file(typelib);
    if (file == Qnil) {
        file = typelib;
    }
    pbuf = ole_vstr2wc(file);
    hr = LoadTypeLibEx(pbuf, REGKIND_NONE, &pTypeLib);
    if (FAILED(hr))
        ole_raise(hr, eWIN32OLERuntimeError, "failed to LoadTypeLibEx");
    SysFreeString(pbuf);
    if (oleclass_from_typelib(self, pTypeLib, oleclass) == Qfalse) {
        OLE_RELEASE(pTypeLib);
        rb_raise(eWIN32OLERuntimeError, "not found `%s` in `%s`",
                 StringValuePtr(oleclass), StringValuePtr(typelib));
    }
    OLE_RELEASE(pTypeLib);
    return self;
}

Class Method Details

.ole_classes(typelib)

Returns array of WIN32OLE_TYPE objects defined by the typelib type library. This method will be OBSOLETE. Use WIN32OLE_TYPELIB.new(typelib).ole_classes instead.

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 114


static VALUE
foletype_s_ole_classes(VALUE self, VALUE typelib)
{
    VALUE obj;

    /*
    rb_warn("%s is obsolete; use %s instead.",
            "WIN32OLE_TYPE.ole_classes",
            "WIN32OLE_TYPELIB.new(typelib).ole_types");
    */
    obj = rb_funcall(cWIN32OLE_TYPELIB, rb_intern("new"), 1, typelib);
    return rb_funcall(obj, rb_intern("ole_types"), 0);
}

.progids

Returns array of ProgID.

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 153


static VALUE
foletype_s_progids(VALUE self)
{
    HKEY hclsids, hclsid;
    DWORD i;
    LONG err;
    VALUE clsid;
    VALUE v = rb_str_new2("");
    VALUE progids = rb_ary_new();

    err = reg_open_key(HKEY_CLASSES_ROOT, "CLSID", &hclsids);
    if(err != ERROR_SUCCESS) {
        return progids;
    }
    for(i = 0; ; i++) {
        clsid = reg_enum_key(hclsids, i);
        if (clsid == Qnil)
            break;
        err = reg_open_vkey(hclsids, clsid, &hclsid);
        if (err != ERROR_SUCCESS)
            continue;
        if ((v = reg_get_val2(hclsid, "ProgID")) != Qnil)
            rb_ary_push(progids, v);
        if ((v = reg_get_val2(hclsid, "VersionIndependentProgID")) != Qnil)
            rb_ary_push(progids, v);
        RegCloseKey(hclsid);
    }
    RegCloseKey(hclsids);
    return progids;
}

.typelibs

Returns array of type libraries. This method will be OBSOLETE. Use WIN32OLE_TYPELIB.typelibs.collect{|t| t.name} instead.

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 136


static VALUE
foletype_s_typelibs(VALUE self)
{
    /*
    rb_warn("%s is obsolete. use %s instead.",
            "WIN32OLE_TYPE.typelibs",
            "WIN32OLE_TYPELIB.typelibs.collect{t|t.name}");
    */
    return rb_eval_string("WIN32OLE_TYPELIB.typelibs.collect{|t|t.name}");
}

Instance Attribute Details

#visible?(#=> true or false) (readonly)

Returns true if the OLE class is public.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
puts tobj.visible  # => true

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 455


static VALUE
foletype_visible(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_visible(pTypeInfo);
}

Instance Method Details

#default_event_sources

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FSOURCE and IMPLTYPEFLAG_FDEFAULT.

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
p tobj.default_event_sources  # => [#<WIN32OLE_TYPE:DWebBrowserEvents2>]

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 847


static VALUE
foletype_default_event_sources(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FSOURCE|IMPLTYPEFLAG_FDEFAULT);
}

#default_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FDEFAULT.

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
p tobj.default_ole_types
# => [#<WIN32OLE_TYPE:IWebBrowser2>, #<WIN32OLE_TYPE:DWebBrowserEvents2>]

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 864


static VALUE
foletype_default_ole_types(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FDEFAULT);
}

#guid(#=> GUID)

Returns GUID.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
puts tobj.guid  # => {00024500-0000-0000-C000-000000000046}

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 387


static VALUE
foletype_guid(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_guid(pTypeInfo);
}

#helpcontext

Returns helpcontext. If helpcontext is not found, then returns nil.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
puts tobj.helpfile # => 131185

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 659


static VALUE
foletype_helpcontext(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_helpcontext(pTypeInfo);
}

#helpfile

Returns helpfile path. If helpfile is not found, then returns nil.

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

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 632


static VALUE
foletype_helpfile(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_helpfile(pTypeInfo);
}

#helpstring(#=> help string.)

Returns help string.

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
puts tobj.helpstring # => Web Browser interface

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 570


static VALUE
foletype_helpstring(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_helpstring(pTypeInfo);
}

#implemented_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
p tobj.implemented_ole_types # => [_Worksheet, DocEvents]

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 814


static VALUE
foletype_impl_ole_types(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_impl_ole_types(pTypeInfo, 0);
}

#inspect ⇒ `String`

Returns the type name with class name.

ie = WIN32OLE.new('InternetExplorer.Application')
ie.ole_type.inspect => #<WIN32OLE_TYPE:IWebBrowser2>

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 880


static VALUE
foletype_inspect(VALUE self)
{
    return default_inspect(self, "WIN32OLE_TYPE");
}

#major_version

Returns major version.

tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
puts tobj.major_version # => 8

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 484


static VALUE
foletype_major_version(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_major_version(pTypeInfo);
}

#minor_version(#=> OLE minor version)

Returns minor version.

tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
puts tobj.minor_version # => 2

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 513


static VALUE
foletype_minor_version(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_minor_version(pTypeInfo);
}

#to_s(#=> OLE type name) #name(#=> OLE type name)

Alias for #to_s.

#ole_methods(# the array of WIN32OLE_METHOD objects.)

Returns array of ::WIN32OLE_METHOD objects which represent OLE method defined in OLE type library.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
methods = tobj.ole_methods.collect{|m|
  m.name
}
# => ['Activate', 'Copy', 'Delete',....]

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 741


static VALUE
foletype_methods(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_methods_from_typeinfo(pTypeInfo, INVOKE_FUNC | INVOKE_PROPERTYGET | INVOKE_PROPERTYPUT | INVOKE_PROPERTYPUTREF);
}

#ole_type(#=> OLE type string.)

returns type of OLE class.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
puts tobj.ole_type  # => Class

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 353


static VALUE
foletype_ole_type(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_ole_type(pTypeInfo);
}

#ole_typelib

Returns the ::WIN32OLE_TYPELIB object which is including the WIN32OLE_TYPE object. If it is not found, then returns nil.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Worksheet')
puts tobj.ole_typelib # => 'Microsoft Excel 9.0 Object Library'

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 757


static VALUE
foletype_ole_typelib(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_typelib_from_itypeinfo(pTypeInfo);
}

#progid(#=> ProgID)

Returns ProgID if it exists. If not found, then returns nil.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
puts tobj.progid  # =>   Excel.Application.9

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 421


static VALUE
foletype_progid(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_progid(pTypeInfo);
}

#source_ole_types

Returns the array of WIN32OLE_TYPE object which is implemented by the WIN32OLE_TYPE object and having IMPLTYPEFLAG_FSOURCE.

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', "InternetExplorer")
p tobj.source_ole_types
# => [#<WIN32OLE_TYPE:DWebBrowserEvents2>, #<WIN32OLE_TYPE:DWebBrowserEvents>]

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 831


static VALUE
foletype_source_ole_types(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_impl_ole_types(pTypeInfo, IMPLTYPEFLAG_FSOURCE);
}

#src_type(#=> OLE source class)

Returns source class when the OLE class is ‘Alias’.

tobj =  WIN32OLE_TYPE.new('Microsoft Office 9.0 Object Library', 'MsoRGBType')
puts tobj.src_type # => I4

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 604


static VALUE
foletype_src_type(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_src_type(pTypeInfo);
}

#to_s(#=> OLE type name) Also known as: #name

Returns OLE type name.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application')
puts tobj.name  # => Application

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 293


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

#typekind(#=> number of type.)

Returns number which represents type.

tobj = WIN32OLE_TYPE.new('Microsoft Word 10.0 Object Library', 'Documents')
puts tobj.typekind # => 4

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 543


static VALUE
foletype_typekind(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_type_typekind(pTypeInfo);
}

#variables

Returns array of ::WIN32OLE_VARIABLE objects which represent variables defined in OLE class.

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'XlSheetType')
vars = tobj.variables
vars.each do |v|
  puts "#{v.name} = #{v.value}"
end

The result of above sample script is follows:
  xlChart = -4109
  xlDialogSheet = -4116
  xlExcel4IntlMacroSheet = 4
  xlExcel4MacroSheet = 3
  xlWorksheet = -4167

[ GitHub ]

# File 'ext/win32ole/win32ole_type.c', line 722


static VALUE
foletype_variables(VALUE self)
{
    ITypeInfo *pTypeInfo = itypeinfo(self);
    return ole_variables(pTypeInfo);
}

Class: WIN32OLE_TYPE

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(typelib, ole_class) ⇒ WIN32OLE_TYPE

Class Method Details

.ole_classes(typelib)

.progids

.typelibs

Instance Attribute Details

#visible?(#=> true or false) (readonly)

Instance Method Details

#default_event_sources

#default_ole_types

#guid(#=> GUID)

#helpcontext

#helpfile

#helpstring(#=> help string.)

#implemented_ole_types

#inspect ⇒ String

#major_version

#minor_version(#=> OLE minor version)

#to_s(#=> OLE type name) #name(#=> OLE type name)

#ole_methods(# the array of WIN32OLE_METHOD objects.)

#ole_type(#=> OLE type string.)

#ole_typelib

#progid(#=> ProgID)

#source_ole_types

#src_type(#=> OLE source class)

#to_s(#=> OLE type name) Also known as: #name

#typekind(#=> number of type.)

#variables

.new(typelib, ole_class) ⇒ `WIN32OLE_TYPE`

#inspect ⇒ `String`