検索結果

WIN32OLE (132217.0)

• 2.2.0

• クラス

OLEオートメーションサーバをRubyで操作するためのクラスです。

OLEオートメーションサーバをRubyで操作するためのクラスです。

Windowsの多くのアプリケーションやライブラリは、COMと呼ばれるAPI群を利用
して他のプログラムから操作できます。WIN32OLEがサポートしているのは、
COMのAPIのうち、特にインタープリタ用のインターフェイスであるOLEオートメー
ション（IDispatchインターフェイス）とそれに付随するリフレクション用のイ
ンターフェイスです。

これらのインターフェイスをサポートしている代表的なWindowsアプリケーショ
ンに、Office、IE、iTunes、Illustratorがあります。また、WMI、WshS...

WIN32OLE#ole_query_interface(iid) -> WIN32OLE (91030.0)

• 2.2.0

• インスタンスメソッド

IID（インターフェイスID）を指定してオブジェクトの別のインターフェイスを 持つオブジェクトを取得します。

IID（インターフェイスID）を指定してオブジェクトの別のインターフェイスを
持つオブジェクトを取得します。

オブジェクトが複数のオートメーション用インターフェイスを持つ場合に、当
メソッドを利用して既定のインターフェイスとは異なるインターフェイスを取
得します。

@param iid 取得するインターフェイスのIIDを文字列で指定します。
@return iidパラメータで指定したインターフェイスを持つWIN32OLEオブジェクト
@raise WIN32OLERuntimeError 指定したIIDをオブジェクトが持たない場合に通知されます。

ie = WIN32OLE.n...

• WIN32OLE

WIN32OLE#_invoke(dispid, args, types) -> object | nil (90481.0)

• 2.2.0

• インスタンスメソッド

DISPIDとパラメータの型を指定してオブジェクトのメソッドを呼び出します。

DISPIDとパラメータの型を指定してオブジェクトのメソッドを呼び出します。

呼び出すメソッドのインターフェイスを事前に知っている場合に、DISPIDとパ
ラメータの型を指定してメソッドを呼び出します。

このメソッドは引数の変換方法をプログラマが制御できるようにすることと、
COMアーリーバインディングを利用して外部プロセスサーバとのラウンドトリッ
プを減らして処理速度を向上させることを目的としたものです。後者の目的に
ついては、DLLの形式で型情報（TypeLib）を提供しているサーバに対してはあ
まり意味を持ちません。そのため、型の高精度な制御が不要な場合は、直接メ
ソッド名を指定した...

• WIN32OLE
• WIN32OLE::VARIANT

WIN32OLE#invoke(name, *args) -> object | nil (90373.0)

• 2.2.0

• インスタンスメソッド

メソッド名を指定してオブジェクトのメソッドを呼び出します。

メソッド名を指定してオブジェクトのメソッドを呼び出します。

OLEオートメーションサーバのメソッドを動的に呼び出したい場合に利用します。

なお、OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別
されません。

@param name メソッド名を文字列またはシンボルで指定します。
@param args メソッドの引数を指定します。また、最後の引数にHashを
与えることで、名前付き引数を指定できます。この場合、キーに
文字列またはシンボルでパラメータ名、値に引数を指定します。
@return メソッドの返り値。ただし返り...

• Hash
• WIN32OLE

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (82042.0)

• 2.2.0

• インスタンスメソッド

オブジェクトに対応する型情報ライブラリ（TypeLib）を WIN32OLE_TYPELIBとして返します。

オブジェクトに対応する型情報ライブラリ（TypeLib）を
WIN32OLE_TYPELIBとして返します。

OLEオートメーションではクラス、インターフェイス、メソッド、引数などの型
情報と文書情報を型情報ライブラリとして利用します。型情報ライブラリは独
立したファイル（拡張子tlb）の場合もあれば、オブジェクトのバイナリへリソー
スとして埋め込まれている場合があります。

OLEオートメーションでは型情報ライブラリの提供方法を問わずに統一したイン
ターフェイスでアプリケーションが参照できるように、オブジェクトの形式
（ITypeInfoインターフェイス）で提供します。WIN32OLEは...

• WIN32OLE
• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE#ole_func_methods -> [WIN32OLE_METHOD] (72778.0)

• 2.2.0

• インスタンスメソッド

オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し ます。

オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し
ます。

ole_func_methodsメソッドは、OLEオートメーションサーバのメソッドのうちファ
ンクション（何らかの機能的な操作）に属するものをWIN32OLE_METHODの
配列として返します。

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

exc...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE#ole_get_methods -> [WIN32OLE_METHOD] (72778.0)

• 2.2.0

• インスタンスメソッド

オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として 返します。

オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として
返します。

ole_get_methodsメソッドは、OLEオートメーションサーバのメソッドのうち読
み取り可能なプロパティをWIN32OLE_METHODの配列として返します。

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

excel = WIN32OLE...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE#ole_put_methods -> [WIN32OLE_METHOD] (72778.0)

• 2.2.0

• インスタンスメソッド

オブジェクトの設定可能プロパティ情報をWIN32OLE_METHODの配列として 返します。

オブジェクトの設定可能プロパティ情報をWIN32OLE_METHODの配列として
返します。

ole_put_methodsメソッドは、OLEオートメーションサーバのメソッドのうちプ
ロパティ設定メソッドに属するものをWIN32OLE_METHODの配列として返し
ます。

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

excel = W...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE.const_load(ole, mod = WIN32OLE) -> () (72766.0)

• 2.2.0

• 特異メソッド

OLEオートメーションサーバが保持する定数を読み込み、指定されたモジュール に組み込みます。

OLEオートメーションサーバが保持する定数を読み込み、指定されたモジュール
に組み込みます。

OLEオートメーションサーバは、定数をクライアントへ提供できます。

const_loadメソッドはこれらの定数を読み込み、指定したモジュールに組み込
むことで参照可能とします。

@param ole 定数を読み込む対象のWIN32OLEオブジェクトまたはタイプライブラ
リ名（文字列）を指定します。

@param mod 定数を定義する対象のモジュールを指定します。省略時は
WIN32OLEに組み込まれます。

@raise WIN32OLERunt...

• WIN32OLE

WIN32OLE#ole_obj_help -> WIN32OLE_TYPE | nil (72763.0)

• 2.2.0

• インスタンスメソッド

WIN32OLE_TYPEオブジェクトを返します。

WIN32OLE_TYPEオブジェクトを返します。

WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。

@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。

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

@see WIN32OLE_TYPE

• WIN32OLE
• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE#ole_type -> WIN32OLE_TYPE | nil (72763.0)

• 2.2.0

• インスタンスメソッド

WIN32OLE_TYPEオブジェクトを返します。

WIN32OLE_TYPEオブジェクトを返します。

WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。

@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。

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

@see WIN32OLE_TYPE

• WIN32OLE
• WIN32OLE_TYPE

WIN32OLE#ole_methods -> [WIN32OLE_METHOD] (72760.0)

• 2.2.0

• インスタンスメソッド

オブジェクトのメソッド情報をWIN32OLE_METHODの配列として返します。

オブジェクトのメソッド情報をWIN32OLE_METHODの配列として返します。

ole_methodsメソッドは、OLEオートメーションサーバが提供するすべてのメソッ
ドをWIN32OLE_METHODの配列として返します。

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

excel = WIN32OLE.new('Excel.Appli...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE.new(server, host=nil) -> WIN32OLE (72748.0)

• 2.2.0

• 特異メソッド

OLEオートメーションサーバを生成します。

OLEオートメーションサーバを生成します。

引数で指定したCLSIDまたはPROGIDを持つOLEオートメーションサーバを生成し
ます。生成に成功した場合、該当サーバを操作可能なWIN32OLEオブジェクトが
返ります。

CLSIDおよびPROGIDについてはWIN32OLE.connectを参照してください。

@param server OLEオートメーションサーバを示すPROGIDまたはCLSIDを文字列
で指定します。

@param host サーバを生成するホストのホスト名またはIPアドレスを文字列で
指定します。省略時は現在...

• WIN32OLE

WIN32OLE#ole_method(method) -> WIN32OLE_METHOD (72709.0)

• 2.2.0

• インスタンスメソッド

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。

OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。

@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE#ole_method_help(method) -> WIN32OLE_METHOD (72709.0)

• 2.2.0

• インスタンスメソッド

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。

OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。

@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発...

• WIN32OLE
• WIN32OLE_METHOD

絞り込み条件を変える

WIN32OLE.connect(ole) -> WIN32OLE (72694.0)

• 2.2.0

• 特異メソッド

現在実行中のOLEオートメーションサーバに接続します。

現在実行中のOLEオートメーションサーバに接続します。

connectメソッドは、COMのモニカを利用して、現在実行中のOLEオートメーショ
ンサーバを検索し、接続します。接続に成功した場合、該当サーバを操作可能
なWIN32OLEオブジェクトが返ります。

@param ole 接続対象のサーバを示すPROGID、CLSIDまたはモニカ（別名）を指定します。

@return ole引数で特定されるWIN32OLEオブジェクトを返します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
...

• WIN32OLE

WIN32OLE#_getproperty(dispid, args, types) -> object (72481.0)

• 2.2.0

• インスタンスメソッド

DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。

DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。

アクセスするプロパティのインターフェイスを事前に知っている場合に、
DISPIDとパラメータの型を指定してプロパティを参照します。

@param dispid プロパティのDISPID（メソッドを一意に特定する数値）を指定
します。

@param args プロパティが引数を取る場合に配列で指定します。引数の順序は
最左端の引数のインデックスを0とします。引数が不要な場合は空
配列を指定します。

@param types プロパティが...

• WIN32OLE
• WIN32OLE::VARIANT

WIN32OLE#_setproperty(dispid, args, types) -> () (72481.0)

• 2.2.0

• インスタンスメソッド

DISPIDとパラメータの型を指定してオブジェクトのプロパティを設定します。

DISPIDとパラメータの型を指定してオブジェクトのプロパティを設定します。

アクセスするプロパティのインターフェイスを事前に知っている場合に、
DISPIDとパラメータの型を指定してプロパティを設定します。

このメソッドはCOMアーリーバインディングを利用することで外部プロセスサー
バとのラウンドトリップを減らして処理速度を向上させることを目的としたも
のです。このため、DLLの形式で型情報（TypeLib）を提供しているサーバに対
してはあまり意味を持ちません。

@param dispid プロパティのDISPID（メソッドを一意に特定する数値）を指定
し...

• WIN32OLE
• WIN32OLE::VARIANT

WIN32OLE.ole_show_help(obj, helpcontext = nil) -> () (72475.0)

• 2.2.0

• 特異メソッド

WIN32OLEオブジェクトのヘルプファイルを表示します。

WIN32OLEオブジェクトのヘルプファイルを表示します。

Windows標準のヘルプ表示コンポーネントのHHCtrl.OCXを利用して、オブジェク
トに関連付けられたヘルプファイル（chmファイル）を表示します。

また、chmファイルのフルパス名を指定して表示させることも可能です。

@param obj WIN32OLE_TYPEオブジェクトまたはWIN32OLE_METHODオ
ブジェクト。直接ヘルプファイルのフルパス名を指定することも可
能です。

@param helpcontext obj引数にWIN32OLE_TYPEオブジェクト...

• WIN32OLE
• WIN32OLE_METHOD
• WIN32OLE_TYPE

WIN32OLE#each {|i|...} -> () (72358.0)

• 2.2.0

• インスタンスメソッド

オブジェクトの列挙インターフェイスを呼び出してアイテム単位にブロックを 実行します。

オブジェクトの列挙インターフェイスを呼び出してアイテム単位にブロックを
実行します。

OLEオートメーションサーバの中には、コレクション用インターフェイスを持つ
ものがあります。eachメソッドは、このようなオブジェクトの列挙メソッドを
呼び出して、アイテム毎のイテレーションを行います。

@param i コレクション内のアイテム

@raise WIN32OLERuntimeError selfが列挙インターフェイスをサポートしてい
ない場合に通知します。

excel = WIN32OLE.new('Excel.Appli...

• WIN32OLE

絞り込み条件を変える

WIN32OLE#ole_free -> () (72145.0)

• 2.2.0

• インスタンスメソッド

selfが参照するCOMオブジェクトを解放します。

selfが参照するCOMオブジェクトを解放します。

selfが参照するCOMオブジェクトのIUnknown::Releaseを呼び出すことで、COMオ
ブジェクトを開放します。ole_freeを呼び出した後は、このオブジェクトに対
する操作は行えません。

excel = WIN32OLE.new('Excel.Application')
excel.ole_free # オブジェクトの解放
excel.Quit #=> RuntimeError (failed to get Dispatch Interface)

通常は利用されなくなったWIN32OLEオブジェ...

• WIN32OLE

WIN32OLE#ole_respond_to?(name) -> bool (72037.0)

• 2.2.0

• インスタンスメソッド

指定したメソッドをオブジェクトがサポートしているか調べます。

指定したメソッドをオブジェクトがサポートしているか調べます。

OLEオートメーションサーバが引数で指定した名前のメソッド（プロパティ）を
サポートしているかどうかを調べます。

なお、OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別
されません。

@param name 調べるメソッド名を文字列またはシンボルで指定します。

@return nameで指定したメソッドをオブジェクトが提供していれば真を返します。

excel = WIN32OLE.new('Excel.Application')
excel.ole_respond_to?(:quit) #=...

• WIN32OLE

WIN32OLE#setproperty(name, args..., val) -> () (72037.0)

• 2.2.0

• インスタンスメソッド

オブジェクトのプロパティを設定します。

オブジェクトのプロパティを設定します。

プロパティ名を指定してOLEオートメーションオブジェクトのプロパティ
（Rubyの属性に相当）を設定します。

なお、OLEオートメーションの仕様により、プロパティ名の大文字、小文字は区
別されません。

@param name プロパティ名を文字列またはシンボルで指定します。
@param val プロパティに設定する値を指定します。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗し...

• WIN32OLE

WIN32OLE#setproperty(name, val) -> () (72037.0)

• 2.2.0

• インスタンスメソッド

オブジェクトのプロパティを設定します。

オブジェクトのプロパティを設定します。

プロパティ名を指定してOLEオートメーションオブジェクトのプロパティ
（Rubyの属性に相当）を設定します。

なお、OLEオートメーションの仕様により、プロパティ名の大文字、小文字は区
別されません。

@param name プロパティ名を文字列またはシンボルで指定します。
@param val プロパティに設定する値を指定します。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗し...

• WIN32OLE

WIN32OLE_METHOD (36199.0)

• 2.2.0

• クラス

OLEオートメーションサーバが持つメソッドの情報を提供します。

OLEオートメーションサーバが持つメソッドの情報を提供します。

WIN32OLE_METHODは、WIN32OLE#ole_methodsなどの呼び出しによって返さ
れるオブジェクトで、OLEオートメーションサーバのメソッドの情報（メタデー
タ）を保持します。

=== サンプルコード

excel = WIN32OLE.new('Excel.Application')
excel.ole_methods.each do |method|
if method.visible?
puts <<SIGNATURE
#{method.return_type} ...

• WIN32OLE_PARAM

絞り込み条件を変える

WIN32OLE_VARIANT (36199.0)

• 2.2.0

• クラス

OLEオートメーションの標準型のVARIANTオブジェクトをRubyで利用するための クラスです。

OLEオートメーションの標準型のVARIANTオブジェクトをRubyで利用するための
クラスです。

VARIANT型とは、型情報と値のペアから構成されるデータ型で、元はVBの型無し
変数のための構造体です。OLEオートメーションのメソッド呼び出しには汎用型
として引数にはVARIANT型を利用します。

* 型情報は、WIN32OLE_VARIANT#vartypeで取得できます。
* 値は、WIN32OLE_VARIANT#valueで取得できます。

OLEオートメーションのメソッド呼び出し規約では、引数はVARIANT型の配列と
して定義されています。

この規約に対して、WIN3...

WIN32OLE_TYPE (36193.0)

• 2.2.0

• クラス

WIN32OLE_TYPEオブジェクトは、型情報ライブラリ（TypeLib）内に定義された 1つの型情報を保持します。

WIN32OLE_TYPEオブジェクトは、型情報ライブラリ（TypeLib）内に定義された
1つの型情報を保持します。

=== サンプルコード

require 'win32ole'

excel_app_type = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
puts excel_app_type.progid # => "Excel.Application.14"



Ruby-1.9.1以降、WIN32OLE_TYPELIBオブジェクトの
WIN32OLE_TYPELIB...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB (36109.0)

• 2.2.0

• クラス

OLEオートメーションサーバの型情報ライブラリ（TypeLib）を操作するための クラスです。

OLEオートメーションサーバの型情報ライブラリ（TypeLib）を操作するための
クラスです。

OLEオートメーションサーバはクライアントに、クラス、インターフェイス、メ
ソッドなどのメタデータを提供するための機構を持ちます。この情報は拡張子
からTLBと呼ばれるライブラリまたはオートメーションサーバのプログラム内の
リソースとして保持され、クライアントからの要求によって参照可能となりま
す。

WIN32OLE_TYPELIBクラスは、TypeLibを操作して各種情報を参照するためのオブ
ジェクトを生成します。

=== サンプルコード

require 'win32ole'

...

WIN32OLE_EVENT (36091.0)

• 2.2.0

• クラス

OLEオートメーションサーバからのイベント通知を制御するクラスです。

OLEオートメーションサーバからのイベント通知を制御するクラスです。

OLEオートメーションサーバによっては、サーバの処理の過程でクライアントが
あらかじめ登録したメソッドを呼び出すものがあります。このサーバが登録し
たメソッドを呼び出す動作を「イベント」と呼びます。WIN32OLE_EVENTを利用
すると、ブロックの形式でイベントを受け取るメソッドをサーバへ登録できま
す。

=== サンプルコード

ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBr...

WIN32OLE_TYPE#progid -> String | nil (27445.0)

• 2.2.0

• インスタンスメソッド

selfのPROGIDを取得します。

selfのPROGIDを取得します。

PROGIDは、生成可能なOLEオートメーションサーバのCoClass（コンポーネント
クラス）が持つレジストリ登録名です。WIN32OLE.newの引数に指定して
WIN32OLEオブジェクトを生成できます。

@return selfのPROGIDを文字列で返します。selfがPROGIDを持たない、または
CoClassでない場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE.progids -> [String] (27409.0)

• 2.2.0

• 特異メソッド

システムに登録されているすべてのコンポーネントクラスのPROGIDを取得します。

システムに登録されているすべてのコンポーネントクラスのPROGIDを取得します。

@return システムに登録されているすべてのコンポーネントクラスのPROGIDを
文字列配列で返します。

excel = nil
WIN32OLE_TYPE.progids.each do |pg|
if pg =~ /excel\.application/i # ExcelのPROGIDをバージョン無視で取り出す
excel = WIN32OLE.new(pg)
break
end
end
unless excel
$s...

• WIN32OLE_TYPE

WIN32OLE_EVENT#on_event_with_outargs(event = nil) {|*args| ... } -> () (27391.0)

• 2.2.0

• インスタンスメソッド

イベント通知を受けて結果を呼び出し元へ返すブロックを登録します。

イベント通知を受けて結果を呼び出し元へ返すブロックを登録します。

引数にはイベントのメソッド名を指定します。引数を省略した場合は、すべて
のイベントを対象とするブロックの登録となります。

WIN32OLE_EVENT#on_eventと異なり、イベントのブロック変数に戻り値を
設定できます。

@param event イベント名を文字列かシンボルで指定します。イベント名は大文
字小文字を区別します。省略時にはすべてのイベントが対象となります。

@param args サーバがイベント通知時に指定した引数の配列です。
eventパラメータ...

• WIN32OLE_EVENT

WIN32OLE_METHOD#return_type_detail -> [String] (27373.0)

• 2.2.0

• インスタンスメソッド

返り値の型と属性を取得します。

返り値の型と属性を取得します。

@return 返り値の型と属性を文字列配列で返します。

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

属性が付加されていない場合は、WIN32OLE_METHOD#return_typeを要素と
...

• WIN32OLE_METHOD

WIN32OLE_TYPE#guid -> String | nil (27337.0)

• 2.2.0

• インスタンスメソッド

この型のGUID（グローバル一意識別子）を取得します。

この型のGUID（グローバル一意識別子）を取得します。

@return GUIDを文字列で返します。GUIDを持たない型の場合はnilを返します。

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

GUIDは、COMのクラス識別子(CLSID)、インターフェイス識別子(IID)など多数の
領域でWindows上のオブジェクトの識別に利用される128ビットの...

• WIN32OLE_TYPE

WIN32OLE_TYPE#visible? -> bool (27337.0)

• 2.2.0

• インスタンスメソッド

この型が公開されているかどうかを照会します。

この型が公開されているかどうかを照会します。

@return 公開されていれば真を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.visible? # => true

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_PARAM.new(ole_method, index) -> WIN32OLE_PARAM (19078.0)

• 2.2.0

• 特異メソッド

メソッドとパラメータ位置を指定してWIN32OLE_PARAMのインスタンスを作成します。

メソッドとパラメータ位置を指定してWIN32OLE_PARAMのインスタンスを作成します。

アプリケーションプログラムでは、WIN32OLE_PARAMオブジェクトをnewメソッド
で生成するよりも、WIN32OLE_METHOD#paramsを参照するほうが簡単です。

@param ole_method パラメータを取得するWIN32OLE_METHODのインスタンス。
@param index パラメータの位置。最左端を1とします。
@return メソッドの指定位置のパラメータの情報を持つオブジェクトを返します。
@raise TypeError ole_methodパラメータがW...

• WIN32OLE_METHOD
• WIN32OLE_PARAM

WIN32OLE_VARIANT.new(val, vartype = nil) -> WIN32OLE_VARIANT (18850.0)

• 2.2.0

• 特異メソッド

指定したオブジェクトを値とするWIN32OLE_VARIANTオブジェクトを生成します。

指定したオブジェクトを値とするWIN32OLE_VARIANTオブジェクトを生成します。

@param val ラップするRubyオブジェクトを指定します。
@param vartype 省略時はWIN32OLEが自動型変換を行います。指定する場合は
WIN32OLE::VARIANTの定数を指定してください。
@return val引数を値として持つWIN32OLE_VARIANTオブジェクトを返します。

@raise TypeError val引数の型がArray、String、Integer、Float、Time、
WI...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

WIN32OLE_EVENT.new(ole, event = nil) -> WIN32OLE_EVENT (18802.0)

• 2.2.0

• 特異メソッド

OLEオートメーションサーバのイベント受信機構をオブジェクト化して返します。

OLEオートメーションサーバのイベント受信機構をオブジェクト化して返します。

newメソッドは、OLEオートメーションサーバがイベント通知に利用するインター
フェイスを取得し、オブジェクトとして返します。

@param ole イベントの通知元のWIN32OLEオブジェクトを指定します。

@param event イベントのインターフェイスを示すインターフェイス名または
IIDを文字列で指定します。省略時にはoleパラメータで指定した
オブジェクトの既定のイベントインターフェイスを利用します。

@return 指定したオブジェクトの...

• WIN32OLE_EVENT

WIN32OLE_TYPE.new(libname, ole_class) -> WIN32OLE_TYPE (18796.0)

• 2.2.0

• 特異メソッド

WIN32OLE_TYPEオブジェクトを生成します。

WIN32OLE_TYPEオブジェクトを生成します。

@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で指定します。
@param ole_class 型情報を取り出す型の名前を指定します。
@return 指定されたTypeLIbに定義された型の情報を格納したWIN32OLE_TYPEオブジェクトを返します。
@raise W...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_EVENT#on_event(event = nil) {|*args| ... } -> () (18445.0)

• 2.2.0

• インスタンスメソッド

イベント通知を受けるブロックを登録します。

イベント通知を受けるブロックを登録します。

引数にはイベントのメソッド名を指定します。引数を省略した場合は、すべて
のイベントを対象とするブロックの登録となります。

@param event イベント名を文字列かシンボルで指定します。イベント名は大文
字小文字を区別します。省略時にはすべてのイベントが対象となります。

@param args サーバがイベント通知時に指定した引数です。
eventパラメータを省略した場合、第1引数にはイベントのメソッ
ド名が文字列で与えられます。引数の変更が必要な場合は、
...

• WIN32OLE_EVENT

絞り込み条件を変える

WIN32OLE_METHOD#return_type -> String (18409.0)

• 2.2.0

• インスタンスメソッド

メソッドの返り値の型名を取得します。

メソッドの返り値の型名を取得します。

@return 返り値の型名を示す文字列を返します。
@raise WIN32OLERuntimeError メソッドの型情報を取得できなかった場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Visible')
puts method.return_type # => BOOL

OLEオートメーションの型名は、対応するWIN32OLE...

• WIN32OLE::VARIANT
• WIN32OLE_METHOD

WIN32OLE_METHOD#return_vtype -> Integer (18355.0)

• 2.2.0

• インスタンスメソッド

メソッドの返り値の型を示す数値を取得します。

メソッドの返り値の型を示す数値を取得します。

@return 返り値の型を示す数値（VARENUM）を返します。
@raise WIN32OLERuntimeError メソッドの型情報を取得できなかった場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Visible')
puts method.return_vtype # => 11

VARENUMの定義は、Platfo...

• WIN32OLE_METHOD

WIN32OLE_TYPE#name -> String (18355.0)

• 2.2.0

• インスタンスメソッド

selfの型名を取得します。

selfの型名を取得します。

@return selfの型名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"

• WIN32OLE_TYPE

WIN32OLE_TYPE#ole_type -> String | nil (18355.0)

• 2.2.0

• インスタンスメソッド

selfの型の種類（TYPEKIND）を取得します。

selfの型の種類（TYPEKIND）を取得します。

@return selfの型の種類を文字列で返します。情報が取得できない場合はnilを返します。

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

ole_typeには以下があります。

: Enum
列挙子（0）
: Record
ユーザ定義型（メソッドを持たない構造体）（1）
: Module
モジュール（静的関数やデータだけを保持）（2）
: In...

• WIN32OLE_TYPE

WIN32OLE_TYPE#to_s -> String (18355.0)

• 2.2.0

• インスタンスメソッド

selfの型名を取得します。

selfの型名を取得します。

@return selfの型名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_EVENT#handler=(obj) -> () (18091.0)

• 2.2.0

• インスタンスメソッド

イベント処理を実行するオブジェクトを登録します。

イベント処理を実行するオブジェクトを登録します。

イベントハンドラをメソッドとして持つオブジェクトをイベントハンドラとし
て登録します。

イベントハンドラはイベント名に「on」を前置します。もし、イベントに対応
するonメソッドが実装されていなければmethod_missingが呼ばれます。イベン
ト名は大文字小文字を区別するため、正確な記述が必要です。

@param obj イベントに対応するメソッドを持つオブジェクト。イベント受信を
解除するにはnilを指定します。

class IeHandler
def initialize
@com...

• WIN32OLE_EVENT

WIN32OLE_EVENT.message_loop -> () (18073.0)

• 2.2.0

• 特異メソッド

Windowsのメッセージポンプを実行します。

Windowsのメッセージポンプを実行します。

message_loopメソッドは、Windowsメッセージがキューイングされている限りメッ
セージの読み出しとディスパッチを実行します。

COMのスレッド間/プロセス間通信はスレッド内で呼び出しをシリアライズする
ためにWindowsメッセージを利用します。このため、ほとんどのイベント処理は
Windowsメッセージを読み取ってディスパッチすることで通知されます。

ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, ...

• WIN32OLE_EVENT