検索結果

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

• 2.4.0

• 特異メソッド

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

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

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

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

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

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

• WIN32OLE

WIN32OLE_TYPELIB.new(libname, mjv = nil, miv = nil) -> WIN32OLE_TYPELIB (87889.0)

• 2.4.0

• 特異メソッド

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

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

@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で指定します。
@param mjv 作成するTypeLibのメジャーバージョン番号をIntegerで指定します。
または整数部にメジャーバージョン、小数点数部にマイナーバージョ
...

• WIN32OLE_TYPELIB

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

• 2.4.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_METHOD.new(ole_type, method) -> WIN32OLE_METHOD (87883.0)

• 2.4.0

• 特異メソッド

WIN32OLE_TYPEとメソッド名を指定してWIN32OLE_METHODのインスタンス を生成します。

WIN32OLE_TYPEとメソッド名を指定してWIN32OLE_METHODのインスタンス
を生成します。

OLEオートメーションサーバの型情報とメソッド名からWIN32OLE_METHODのイン
スタンスを生成します。

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

@param ole_type WIN32OLE_TYPEのインスタンス。
@param method メソッド名を文字列で指定します。
@return methodパラメータに...

• WIN32OLE_METHOD
• WIN32OLE_TYPE

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

• 2.4.0

• 特異メソッド

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

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

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

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

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

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

• WIN32OLE_EVENT

絞り込み条件を変える

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

• 2.4.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_TYPE.new(libname, ole_class) -> WIN32OLE_TYPE (87781.0)

• 2.4.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#ole_func_methods -> [WIN32OLE_METHOD] (51478.0)

• 2.4.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] (51478.0)

• 2.4.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] (51478.0)

• 2.4.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) -> () (51466.0)

• 2.4.0

• 特異メソッド

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

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

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

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

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

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

@raise WIN32OLERunt...

• WIN32OLE

WIN32OLE#ole_obj_help -> WIN32OLE_TYPE | nil (51463.0)

• 2.4.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 (51463.0)

• 2.4.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] (51460.0)

• 2.4.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#ole_query_interface(iid) -> WIN32OLE (51448.0)

• 2.4.0

• インスタンスメソッド

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

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

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

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

ie = WIN32OLE.n...

• WIN32OLE

絞り込み条件を変える

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (51442.0)

• 2.4.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_TYPELIB

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_METHOD

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_METHOD

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

• 2.4.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#_invoke(dispid, args, types) -> object | nil (51163.0)

• 2.4.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE::VARIANT

絞り込み条件を変える

WIN32OLE#ole_free -> () (51145.0)

• 2.4.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.locale=(lcid) -> nil (51121.0)

• 2.4.0

• 特異メソッド

WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を設 定します。

WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を設
定します。

OLEオートメーションでは、UNIXで利用される"ja_JP"などの国名と言語名を「_」
で接続した文字列ではなく、32ビット整数で示します。32ビットの内訳は上位
16ビットが予約領域で0、下位16ビットが言語ID(LANGID）です。LANGIDは、0〜
9ビットでプライマリ言語ID、10〜15ビットでサブ言語IDを示します。

@param lcid 新たに設定するロケール識別子を整数で指定します。

@raise WIN32OLERuntimeError システムにインストールされてい...

• WIN32OLE

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

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

• WIN32OLE
• WIN32OLE::VARIANT

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE
• WIN32OLE::VARIANT

WIN32OLE::ARGV -> [object] (51091.0)

• 2.4.0

• 定数

直前のメソッド呼び出しの引数を格納した配列です。

直前のメソッド呼び出しの引数を格納した配列です。

OLEオートメーションでは呼び出し先が引数に対して値を設定できます。しかし、
Rubyのメソッド引数は値のみを取るため、そのままでは呼び出し先が設定した
値を参照できません。このような場合、ARGVを参照することで呼び出し先の設
定値を参照できます。

以下のリストは、VBで開発したオブジェクトのメソッド呼び出しを例としてい
ます。このメソッド（Accm）は、第1引数で指定した演算を第2引数と第3引数に
適用し、結果を第2引数に設定します。

' VB (OLE Automation server)
Public Sub Accm(...

• WIN32OLE

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• Hash
• WIN32OLE

WIN32OLE#[](key...) -> object (51055.0)

• 2.4.0

• インスタンスメソッド

オブジェクトのデフォルトプロパティを参照します。

オブジェクトのデフォルトプロパティを参照します。

OLEオートメーションにはデフォルトプロパティというプロパティ名を指定せず
にアクセスできるプロパティがあります。

WIN32OLEからデフォルトプロパティにアクセスするには、[]内に必要なキーを
「,」で区切って記述します。シンボルは文字列として扱います。

なおデフォルトプロパティは記述が省略できるプロパティ名に意味がないため、
OLEオートメーション規約ではItemと命名することが決められています。

@param key プロパティでアクセスする情報を特定するキーを指定します。プロ
パティの特定に複数のキーが必...

• WIN32OLE

WIN32OLE#[]=(key..., value) -> () (51055.0)

• 2.4.0

• インスタンスメソッド

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

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

OLEオートメーションにはデフォルトプロパティというプロパティ名を指定せず
にアクセスできるプロパティがあります。

WIN32OLEからデフォルトプロパティにアクセスするには、[]内に必要なキーを
記述します。

なおデフォルトプロパティは記述が省略できるプロパティ名には意味がありま
せん。このためOLEオートメーション規約では一律にItemと命名することが決め
られています。

@param key プロパティでアクセスする情報を特定するキーを指定します。プロ
パティの特定に複数のキーが必要な場合は「,」で区切って列...

• WIN32OLE

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

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

• WIN32OLE

WIN32OLE#ole_activex_initialize -> nil (51037.0)

• 2.4.0

• インスタンスメソッド

ActiveXコントロール用の初期化を行います。

ActiveXコントロール用の初期化を行います。

ole_activex_initializeメソッドは、スクリプト内でActiveXコントロールを利
用できるように、オブジェクトが持つ永続化データを初期化します。

ActiveXコントロール（OCX）は、主にUI用に利用されるOLEオートメーションサー
バです。ActiveXコントロールは、IDEを利用した開発時と、プログラムの実行
時の2種類の実行モードを持ちます。これは、開発時の設定を永続化するためで
す。

幾つかのActiveXコントロールは、上記の動作を前提に組まれているため、実行
に先だって永続化データの転送をデータの有無と...

• WIN32OLE

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

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

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

• WIN32OLE

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE

WIN32OLE (42217.0)

• 2.4.0

• クラス

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

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

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

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

WIN32OLE_VARIANT (42217.0)

• 2.4.0

• クラス

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

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

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

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

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

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

絞り込み条件を変える

WIN32OLE_METHOD (42199.0)

• 2.4.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_VARIABLE (42181.0)

• 2.4.0

• クラス

OLEオートメーションの変数情報をRubyで参照するためのクラスです。

OLEオートメーションの変数情報をRubyで参照するためのクラスです。

OLEオートメーションサーバは、定数（WIN32OLE.const_load）、メソッ
ド/プロパティ（WIN32OLE_METHOD）、イベント（WIN32OLE_EVENT）
のほかに変数をクライアントへ提供できます。WIN32OLE_VARIABLEクラスは、サー
バが提供する変数の情報をオブジェクト化します。変数情報にはCOMで決められ
た構造体やユーザ定義型のフィールド情報などがありますが、最も良く利用さ
れるのはenum（列挙型）のメンバ情報です。enumのメンバは定数として利用で
きます。

WIN32OL...

• WIN32OLE_EVENT
• WIN32OLE_METHOD

WIN32OLE_TYPE (42175.0)

• 2.4.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_PARAM (42127.0)

• 2.4.0

• クラス

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

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

WIN32OLE_PARAMは、WIN32OLE_METHODのパラメータのメタデータを保持し
ます。

=== サンプルコード

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename...

• WIN32OLE_METHOD

WIN32OLE_EVENT (42109.0)

• 2.4.0

• クラス

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

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

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

=== サンプルコード

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

絞り込み条件を変える

WIN32OLE_TYPELIB (42109.0)

• 2.4.0

• クラス

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

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

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

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

=== サンプルコード

require 'win32ole'

...

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (33772.0)

• 2.4.0

• インスタンスメソッド

型が持つソースインターフェイスを取得します。

型が持つソースインターフェイスを取得します。

default_event_sourcesメソッドは、selfがCoClass（コンポーネントクラス）
の場合、そのクラスがサポートするデフォルトのソースインターフェイス（イ
ベントの通知元となるインターフェイス）を返します。

@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。

tobj = ...

• WIN32OLE_TYPE

WIN32OLE_METHOD#params -> [WIN32OLE_PARAM] (33412.0)

• 2.4.0

• インスタンスメソッド

メソッドのパラメータ情報を取得します。

メソッドのパラメータ情報を取得します。

このメソッドのパラメータをWIN32OLE_PARAMの配列として返します。配
列の最初の要素が最左端のパラメータに対応します。

@return WIN32OLE_PARAMの配列。無引数のメソッドであれば要素数0の配
列を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
p method.params # => ...

• WIN32OLE_METHOD
• WIN32OLE_PARAM

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (33394.0)

• 2.4.0

• インスタンスメソッド

型が持つ変数を取得します。

型が持つ変数を取得します。

型がEnum（列挙型）やユーザ定義型の場合、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。

@return 型が持つ変数情報をWIN32OLE_VARIABLEの配列として返します。
変数を持たない場合は空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
vars = to...

• WIN32OLE_TYPE
• WIN32OLE_VARIABLE

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (33376.0)

• 2.4.0

• インスタンスメソッド

型が持つメソッドのメタデータを取得します。

型が持つメソッドのメタデータを取得します。

@return 型が持つメソッドのメタデータをWIN32OLE_METHODの配列として返します。
メソッドを持たない場合は空配列を返します。


tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
methods = tobj.ole_methods.map {|m| m.name }
# => ['QueryInterface', 'AddRef', 'Release',.....

• WIN32OLE_METHOD
• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#source_ole_types -> [WIN32OLE_TYPE] (33376.0)

• 2.4.0

• インスタンスメソッド

型が持つソースインターフェイスを取得します。

型が持つソースインターフェイスを取得します。

source_ole_typesメソッドは、selfがCoClass（コンポーネントクラス）の場合、
そのクラスがサポートするすべてのソースインターフェイス（イベントの通知
元となるインターフェイス）を返します。

ActiveXコントロールのようにイベント（WIN32OLE_EVENT）をサポートし
ているコンポーネントクラスの場合は、このメソッドの呼び出しによりイベン
トインターフェイスを調べることが可能です。

@return ソースインターフェイスをWIN32OLE_TYPEの配列として返します。
ソースインターフェイスを...

• WIN32OLE_EVENT
• WIN32OLE_TYPE

WIN32OLE_TYPELIB#ole_classes -> [WIN32OLE_TYPE] (33361.0)

• 2.4.0

• インスタンスメソッド

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されている型には、クラス（CoClass——コンポーネントクラス）
やEnum（列挙子）、構造体などがあります。

@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#ole_types -> [WIN32OLE_TYPE] (33361.0)

• 2.4.0

• インスタンスメソッド

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されている型には、クラス（CoClass——コンポーネントクラス）
やEnum（列挙子）、構造体などがあります。

@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPE#default_ole_types -> [WIN32OLE_TYPE] (33358.0)

• 2.4.0

• インスタンスメソッド

型が持つデフォルトのインターフェイスを取得します。

型が持つデフォルトのインターフェイスを取得します。

default_ole_typesメソッドは、selfがCoClass（コンポーネントクラス）の場
合、そのクラスが実装しているデフォルトのインターフェイスと、サポートし
ていればデフォルトのソースインターフェイスを返します。

@return デフォルトインターフェイスをWIN32OLE_TYPEの配列として返し
ます。デフォルトインターフェイスは、最大でも、クラス操作用のイ
ンターフェイス（OLEオートメーション用）と、イベント用のソースイ
ンターフェイスの2要素です。デフォルトインターフ...

• WIN32OLE_TYPE

WIN32OLE_TYPE#implemented_ole_types -> [WIN32OLE_TYPE] (33358.0)

• 2.4.0

• インスタンスメソッド

この型が実装するインターフェイスを取得します。

この型が実装するインターフェイスを取得します。

implemented_ole_typesメソッドは、selfがCoClass（コンポーネントクラス）
の場合、そのクラスが実装しているすべてのインターフェイスを返します。

@return クラスが実装するすべてのインターフェイスをWIN32OLE_TYPEの
配列として返します。この型がインターフェイスを実装しない場合は、
空配列を返します。

@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。

tobj = WIN32OLE_TYPE.new('Micro...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (33358.0)

• 2.4.0

• インスタンスメソッド

この型を登録してある型情報ライブラリ（TypeLib）を取得します。

この型を登録してある型情報ライブラリ（TypeLib）を取得します。

@return この型を登録しているTypeLibをWIN32OLE_TYPELIBオブジェクト
として返します。見つからない場合はnilを返します。

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

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE_EVENT

WIN32OLE_VARIANT#[]=(i..., val) -> object (33175.0)

• 2.4.0

• インスタンスメソッド

配列型のWIN32OLE_VARIANTの要素を設定します。

配列型のWIN32OLE_VARIANTの要素を設定します。

selfは、WIN32OLE_VARIANT.arrayまたは引数に配列を指定して
WIN32OLE_VARIANT.newで作成したインスタンスの必要があります。

@param i 各次元の0からのインデックスを「,」で区切って次元数分指定します。
インデックスは0から要素数-1までのIntegerで指定してください。
@param val 設定値を指定します。Array、String、Integer、Float、
TrueClass、FalseClass、NilClass以外のオブジェ...

• WIN32OLE_VARIANT

WIN32OLE_METHOD#dispid -> Integer (33163.0)

• 2.4.0

• インスタンスメソッド

メソッドのディスパッチID（DISPID）を取得します。

メソッドのディスパッチID（DISPID）を取得します。

ディスパッチIDはメソッドの一意識別子です。WIN32OLEでは、
WIN32OLE#_invokeなどのメソッドで、呼び出すサーバのメソッドを指定
するのに利用します。

@return メソッドのDISPIDを返します。

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

• WIN32OLE_METHOD

WIN32OLE_VARIANT#[](i...) -> object (33157.0)

• 2.4.0

• インスタンスメソッド

配列型のWIN32OLE_VARIANTの要素を取得します。

配列型のWIN32OLE_VARIANTの要素を取得します。

selfは、WIN32OLE_VARIANT.arrayまたは引数に配列を指定して
WIN32OLE_VARIANT.newで作成したインスタンスの必要があります。

@param i 各次元の0からのインデックスを「,」で区切って次元数分指定します。
インデックスは0から要素数-1までのIntegerで指定してください。
@return 引数で指定したインデックスの要素を返します。
@raise ArgError 引数の数が次元数と一致していません。

@raise WIN32OLERuntimeError s...

• WIN32OLE_VARIANT

絞り込み条件を変える

WIN32OLE_METHOD#helpcontext -> Integer | nil (33145.0)

• 2.4.0

• インスタンスメソッド

メソッドのヘルプコンテキストを取得します。

メソッドのヘルプコンテキストを取得します。

ヘルプコンテキストは、関連するヘルプファイル上のトピック位置を示す整数
値です。

@return ヘルプコンテキストを返します。未定義の場合はnilを返します。

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

WIN32OLE_METHODオブジェクトを引数として、WI...

• WIN32OLE_METHOD

WIN32OLE_VARIANT#value=(val) -> () (33139.0)

• 2.4.0

• インスタンスメソッド

WIN32OLE_VARIANTの値を再設定します。

WIN32OLE_VARIANTの値を再設定します。

指定した値でselfを再設定します。指定値が元のVARIANT型に合わない場合は元
のVARIANT型に合うように引数を変換します。変換は、引数を一度VARIANT型に
変換してからCOMのVARIANT型変換関数（VariantChangeTypeEx）を呼び出すこと
で実現します。

@param val 設定値を指定します。
@raise WIN32OLERuntimeError selfが配列型です。あるいは、型変換に失敗し
ました。

obj = WIN32OLE_V...

• WIN32OLERuntimeError
• WIN32OLE_VARIANT

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

class IeHandler
def initialize
@com...

• WIN32OLE_EVENT

WIN32OLE_METHOD#helpfile -> String | nil (33127.0)

• 2.4.0

• インスタンスメソッド

ヘルプファイルのパス名を取得します。

ヘルプファイルのパス名を取得します。

メソッドにヘルプファイルが関連付けられている場合、該当ヘルプファイルの
パス名を返します。

@return ヘルプファイルのパス名を文字列で返します。ヘルプファイルが未定
義ならばnilを返します。

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

• WIN32OLE_METHOD

WIN32OLE_TYPE#progid -> String | nil (33127.0)

• 2.4.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_VARIANT#vartype -> Integer (33127.0)

• 2.4.0

• インスタンスメソッド

selfの型情報を取得します。

selfの型情報を取得します。

型情報は、WIN32OLE::VARIANTの定数値の組み合わせです。

obj = WIN32OLE_VARIANT.new("string")
obj.vartype # => 8 (WIN32OLE::VARIANT::VT_BSTR)
bytes = WIN32OLE_VARIANT.new([1,2,3,4,5], VT_UI1 | VT_ARRAY)
bytes.vartype # => 8209 (WIN32OLE::VARIANT::VT_ARRAY | VT_UI1)

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

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

• WIN32OLE_EVENT

WIN32OLE_METHOD#invoke_kind -> String (33109.0)

• 2.4.0

• インスタンスメソッド

メソッドの種類を文字列で取得します。

メソッドの種類を文字列で取得します。

ここで言うメソッドの種類というのは、OLEオートメーションクライアントの記
述言語がどのような形式でサーバ呼び出しを記述すべきかを指定した属性値で
す。

@return メソッドの種類を示す文字列を返します。

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

返送値は以下のい...

• WIN32OLE_METHOD

WIN32OLE_METHOD#return_type -> String (33109.0)

• 2.4.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_PARAM#input? -> bool (33109.0)

• 2.4.0

• インスタンスメソッド

パラメータがクライアントからサーバへ与えるものかを判定します。

パラメータがクライアントからサーバへ与えるものかを判定します。

OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out（サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout（クライアントからサーバ
へ与え、サーバがクライアントへ与える）の3種類の方向属性のいずれかを持ち
ます。

input?メソッドはin属性またはinout属性なら真を返します。

@return メソッドの方向属性がinまたはinoutならば真を返します。

tobj = WIN32OLE...

• WIN32OLE_PARAM

絞り込み条件を変える

WIN32OLE_PARAM#ole_type -> String (33109.0)

• 2.4.0

• インスタンスメソッド

パラメータの型名を取得します。

パラメータの型名を取得します。

@return パラメータの型名を示す文字列を返します。
パラメータの型情報が見つからない場合は、"unknown type"を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.ole_type # => VARIANT

OLEオートメーション...

• WIN32OLE::VARIANT
• WIN32OLE_PARAM

WIN32OLE_PARAM#output? -> bool (33109.0)

• 2.4.0

• インスタンスメソッド

パラメータがクライアントからの結果を受け取るためのものかを判定します。

パラメータがクライアントからの結果を受け取るためのものかを判定します。

OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out（サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout（クライアントからサーバ
へ与え、サーバがクライアントへ与える）の3種類の方向属性のいずれかを持ち
ます。

output?メソッドはout属性またはinout属性なら真を返します。

@return メソッドの方向属性がoutまたはinoutならば真を返します。

tobj = W...

• WIN32OLE_PARAM

WIN32OLE_TYPE#inspect -> String (33109.0)

• 2.4.0

• インスタンスメソッド

selfを説明的な文字列で表現します。

selfを説明的な文字列で表現します。

@return "#<WIN32OLE_TYPE"とWIN32OLE_TYPE#to_sの結果を「:」で結合
し、「>」で閉じた文字列を返します。

x = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts x.inspect #=> #<WIN32OLE_TYPE:Worksheet>

@see WIN32OLE_TYPE#to_s

• WIN32OLE_TYPE

WIN32OLE_TYPE.progids -> [String] (33109.0)

• 2.4.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#off_event(event = nil) -> () (33103.0)

• 2.4.0

• インスタンスメソッド

WIN32OLE_EVENT#on_eventで登録したブロックを解除します。

WIN32OLE_EVENT#on_eventで登録したブロックを解除します。

@param event 文字列またはシンボルで登録時に指定したイベント名を指定しま
す。nilの場合、WIN32OLE_EVENT#on_eventに対してnilを指定したブロッ
クを解除します。

ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents')
ev.on_event(:NavigateComplete) {|url| puts url }
...
ev.off_event(:NavigateComplete)

• WIN32OLE_EVENT

絞り込み条件を変える

WIN32OLE_EVENT.message_loop -> () (33091.0)

• 2.4.0

• 特異メソッド

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

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

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

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

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

• WIN32OLE_EVENT

WIN32OLE_METHOD#event? -> bool (33091.0)

• 2.4.0

• インスタンスメソッド

メソッドがイベントかどうかを取得します。

メソッドがイベントかどうかを取得します。

イベントとはこのサーバが実装しているメソッドではなく、クライアント側が
サーバ側の通知を受けるために実装するメソッドです。

@return メソッドがイベントであれば真。

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

@see WIN32OLE_EVENT

• WIN32OLE_EVENT
• WIN32OLE_METHOD

WIN32OLE_METHOD#return_type_detail -> [String] (33091.0)

• 2.4.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_PARAM#retval? -> bool (33091.0)

• 2.4.0

• インスタンスメソッド

パラメータが戻り値かどうかを判定します。

パラメータが戻り値かどうかを判定します。

OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性（WIN32OLE_PARAM#output?が真）とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述する言語
が戻り値のように扱うか、それとも引数リストに並べるかはretval属性によっ
て決定されます。

retval?メソッドは、戻り値として記述する場合に真となります。

@return パラメータが戻り値として扱われる場合に真を返します。

tobj = WIN32OLE_TYPE.new('DirectX...

• WIN32OLE_PARAM

WIN32OLE_TYPE#helpfile -> String | nil (33091.0)

• 2.4.0

• インスタンスメソッド

オブジェクトに関連付けられたヘルプファイルのフルパス名。

オブジェクトに関連付けられたヘルプファイルのフルパス名。

ここで返されたヘルプファイルを表示するには、
WIN32OLE#ole_show_helpメソッドを呼び出します。

オブジェクトがヘルプファイルを持たない場合はnilを返します。

@return オブジェクトに関連付けられたヘルプファイルのフルパス名を文字列で返します。
ヘルプファイルが未定義の場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpf...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_VARIABLE#ole_type_detail -> [String] (33091.0)

• 2.4.0

• インスタンスメソッド

変数の型と属性を取得します。

変数の型と属性を取得します。

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

tobj = WIN32OLE_TYPE.new('Microsoft XML, v5.0', 'tagSTATSTG')
tobj.variables.each do |v|
puts "#{v.ole_type} [#{v.ole_type_detail.join(', ')}] #{v.name}"
end

出力結果

Unknown Type 31 [] pwcsName # => VT_LPWSTR はWIN32OLE::VARIANTで未定義なので変換でき...

• WIN32OLE_VARIABLE

WIN32OLE_METHOD#event_interface -> String | nil (33073.0)

• 2.4.0

• インスタンスメソッド

メソッドがイベントの場合、イベントのインターフェイス名を取得します。

メソッドがイベントの場合、イベントのインターフェイス名を取得します。

@return メソッドがイベントであれば、イベントのインターフェイス名を返し
ます。イベントでなければnilを返します。

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

• WIN32OLE_METHOD

WIN32OLE_METHOD#helpstring -> String | nil (33073.0)

• 2.4.0

• インスタンスメソッド

メソッドのヘルプ文字列を取得します。

メソッドのヘルプ文字列を取得します。

helpstringは、IDEがメソッドのバルーンヘルプを表示するような場合に利用可
能な、1行程度でメソッドを説明する文字列です。

@return ヘルプ文字列を返します。未定義ならばnilを返します。

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

• WIN32OLE_METHOD

WIN32OLE_METHOD#invkind -> Integer (33073.0)

• 2.4.0

• インスタンスメソッド

メソッドの種類を示すINVOKEKIND列挙値を取得します。

メソッドの種類を示すINVOKEKIND列挙値を取得します。

ここで言うメソッドの種類というのは、OLEオートメーションクライアントの記
述言語がどのような形式でサーバ呼び出しを記述すべきかを指定した属性値で
す。

@return メソッドのINVOKEKINDを返します。

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

INVOKE...

• WIN32OLE_METHOD

WIN32OLE_METHOD#name -> String (33073.0)

• 2.4.0

• インスタンスメソッド

メソッド名を取得します。

メソッド名を取得します。

@return メソッド名を文字列で返します。

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

• WIN32OLE_METHOD

絞り込み条件を変える

WIN32OLE_METHOD#offset_vtbl -> Integer (33073.0)

• 2.4.0

• インスタンスメソッド

このメソッドのVTBLのオフセットを取得します。

このメソッドのVTBLのオフセットを取得します。

VTBLはC++やCでメソッドを呼び出すために利用する関数ポインタのテーブルです。

@return メソッドのVTBL上のオフセットを返します。

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

• WIN32OLE_METHOD

WIN32OLE_METHOD#return_vtype -> Integer (33073.0)

• 2.4.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_METHOD#size_opt_params -> Integer | nil (33073.0)

• 2.4.0

• インスタンスメソッド

オプションパラメータ数を取得します。

オプションパラメータ数を取得します。

@return オプションパラメータ数を整数で返します。メソッドの詳細情報を取
得できない場合はnilを返します。

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

• WIN32OLE_METHOD

WIN32OLE_METHOD#size_params -> Integer | nil (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータ数を取得します。

パラメータ数を取得します。

@return パラメータ数を整数で返します。メソッドの詳細情報を取得できない
場合はnilを返します。


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

• WIN32OLE_METHOD

WIN32OLE_METHOD#to_s -> String (33073.0)

• 2.4.0

• インスタンスメソッド

メソッド名を取得します。

メソッド名を取得します。

@return メソッド名を文字列で返します。

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

• WIN32OLE_METHOD

絞り込み条件を変える

WIN32OLE_METHOD#visible? -> bool (33073.0)

• 2.4.0

• インスタンスメソッド

このメソッドがクライアントに対して公開されているか（可視性を持つか）ど うかを返します。

このメソッドがクライアントに対して公開されているか（可視性を持つか）ど
うかを返します。

@return メソッドが公開されていれば真。

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

• WIN32OLE_METHOD

WIN32OLE_PARAM#default -> object | nil (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータを指定しなかった場合の既定値を取得します。

パラメータを指定しなかった場合の既定値を取得します。

当パラメータが必須パラメータの場合はnilを返します。

@return パラメータを指定しなかった場合の既定値。必須パラメータならばnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
method.params.each do |param|
if param.default
puts "...

• WIN32OLE_PARAM

WIN32OLE_PARAM#name -> String (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータ名を取得します。

パラメータ名を取得します。

@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename

• WIN32OLE_PARAM

WIN32OLE_PARAM#ole_type_detail -> [String] (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータの属性を取得します。

パラメータの属性を取得します。

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

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'IWorksheetFunction')
method = WIN32OLE_METHOD.new(tobj, 'SumIf')
param1 = method.params[0]
p param1.ole_type_detail # => ["PTR", "USERDEFINED", "Range"]

パラメータの取り得る属性値はCOMのIDL（インターフ...

• WIN32OLE_PARAM

WIN32OLE_PARAM#optional? -> bool (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータがオプションかどうかを取得します。

パラメータがオプションかどうかを取得します。

@return パラメータがオプション（省略可能）であれば真を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts "#{param1.name} #{param1.optional?}" # => Filename true

• WIN32OLE_PARAM

絞り込み条件を変える

WIN32OLE_PARAM#to_s -> String (33073.0)

• 2.4.0

• インスタンスメソッド

パラメータ名を取得します。

パラメータ名を取得します。

@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename

• WIN32OLE_PARAM

WIN32OLE_TYPE#typekind -> Integer (33073.0)

• 2.4.0

• インスタンスメソッド

selfの種類を示す値を取得します。

selfの種類を示す値を取得します。

値の意味については、WIN32OLE_TYPE#ole_typeを参照してください。

@return 型の種類を示す数値を返します。
@raise WIN32OLERuntimeError 型の種類（TYPEKIND）を取得できない場合に通知します。

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

@see WIN32OLE_TYPE#ole_type

• WIN32OLE_TYPE

WIN32OLE_TYPE#ole_type -> String | nil (33055.0)

• 2.4.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_VARIABLE#ole_type -> String (33055.0)

• 2.4.0

• インスタンスメソッド

変数の型を取得します。

変数の型を取得します。

@return 変数の型名を文字列で返します。型名を文字列に変換できない場合は、
「Unknown Type nn」（nnはバリアント型を示す数値）の形式の文字列
を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.ole_type} #{variabl...

• WIN32OLE::VARIANT
• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#variable_kind -> String (33055.0)

• 2.4.0

• インスタンスメソッド

変数の種類（VARKIND）を取得します。

変数の種類（VARKIND）を取得します。

この変数の種類を示す文字列を返します。

@return VARKINDに対応する文字列を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.variable_kind}.uniq # => CONSTANT

返送値は以下のいずれかとなります。

: PERINSTANCE
インスタンス毎の変数。構造体やユーザ定義体のフィールド。(0)
: STATI...

• WIN32OLE_VARIABLE

絞り込み条件を変える

WIN32OLE_VARIABLE#varkind -> Integer (33055.0)

• 2.4.0

• インスタンスメソッド

変数の種類（VARKIND）を取得します。

変数の種類（VARKIND）を取得します。

この変数の種類を示す数値を返します。

@return VARKINDに対応する数値を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.varkind}.uniq # => 2

数値の意味については、WIN32OLE_VARIABLE#variable_kindの説明を参照してください。

• WIN32OLE_VARIABLE

WIN32OLE_VARIANT#value -> object (33055.0)

• 2.4.0

• インスタンスメソッド

値に対応するRubyオブジェクトを取得します。

値に対応するRubyオブジェクトを取得します。

@return 値に対応するRubyのオブジェクトを返します。

obj = WIN32OLE_VARIANT.new(1, WIN32OLE::VARIANT::VT_BSTR)
obj.value # => "1" (VT_BSTRを指定して生成したので、Stringオブジェクトとなる)

• WIN32OLE_VARIANT

WIN32OLE_TYPE#guid -> String | nil (33037.0)

• 2.4.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#helpcontext -> Integer | nil (33037.0)

• 2.4.0

• インスタンスメソッド

この型に関連するヘルプファイルのトピックID（ヘルプコンテキスト）を取得 します。

この型に関連するヘルプファイルのトピックID（ヘルプコンテキスト）を取得
します。

@return 型に関連するヘルプコンテキストを整数で返します。ヘルプコンテキ
ストが登録されていない場合はnilを返します。

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

• WIN32OLE_TYPE

WIN32OLE_TYPE#helpstring -> String | nil (33037.0)

• 2.4.0

• インスタンスメソッド

型のドキュメント文字列を取得します。

型のドキュメント文字列を取得します。

@return ドキュメント文字列を返します。未定義の場合はnilを返します。

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

ドキュメント文字列は、コンテキストヘルプなどに利用可能な型の簡単な説明文です。

• WIN32OLE_TYPE

絞り込み条件を変える