検索結果

WIN32OLE_VARIABLE#variable_kind -> String (27307.0)

• 2.5.0

• インスタンスメソッド

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

...得します。

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

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

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

返送値は...

...。構造体やユーザ定義体のフィールド。(0)
: STATIC
クラスの静的変数。(1)
: CONSTANT
定数。enumやモジュールのメンバ。(2)
: DISPATCH
変数アクセスにオートメーションを利用。旧型式のプロパティ。(3)

@see WIN32OLE_VARIABLE#varkind...

• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#visible? -> bool (27307.0)

• 2.5.0

• インスタンスメソッド

変数の可視性を取得します。

...変数の可視性を取得します。

@return publicアクセス可能であれば真を返します。

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

• WIN32OLE_VARIABLE

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (18607.0)

• 2.5.0

• インスタンスメソッド

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

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

OLEオートメーションではクラス、インターフェイス、メソッド、引数などの型
情報と文書情報を型情報ライブラリとして利用します。...

...Infoインターフェイス）で提供します。WIN32OLEは、このオブジェクト
をラップしてWIN32OLE_TYPELIBとして提供します。

@return オブジェクトに対応するWIN32OLE_TYPELIBオブジェクト。
@raise WIN32OLERuntimeError オートメーションサーバの呼...

...び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

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

• WIN32OLE
• WIN32OLE_TYPELIB

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (18607.0)

• 2.5.0

• インスタンスメソッド

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

...TypeLib）を取得します。

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

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

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (18607.0)

• 2.5.0

• インスタンスメソッド

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

...、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。

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

...できない場合に通知します。

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

上記を実行すると以下の出力が得られます。

xlChart = -4109
x...

...lDialogSheet = -4116
xlExcel4IntlMacroSheet = 4
xlExcel4MacroSheet = 3
xlWorksheet = -4167

@see WIN32OLE_VARIABLE...

• WIN32OLE_TYPE
• WIN32OLE_VARIABLE

絞り込み条件を変える

WIN32OLE#ole_obj_help -> WIN32OLE_TYPE | nil (18307.0)

• 2.5.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::CP_SYMBOL -> Integer (18307.0)

• 2.5.0

• 定数

文字コードの変換にシンボルを利用することを示します（42）。

文字コードの変換にシンボルを利用することを示します（42）。

• WIN32OLE

WIN32OLE::VARIANT::VT_BOOL -> Integer (18307.0)

• 2.5.0

• 定数

真偽値を示します（11）。

真偽値を示します（11）。

• WIN32OLE::VARIANT

WIN32OLE::VARIANT::VT_BSTR -> Integer (18307.0)

• 2.5.0

• 定数

文字列（BSTR）を示します（8）。

...文字列（BSTR）を示します（8）。

OLEオートメーションのBSTRはUnicodeで表現された長さ付き文字列です。Ruby
のStringとBSTRの相互変換は、WIN32OLEがWIN32OLE#codepageに基づいて
自動的に行います。...

• WIN32OLE::VARIANT

WIN32OLE::VARIANT::VT_BYREF -> Integer (18307.0)

• 2.5.0

• 定数

参照を示します（0x4000）。

参照を示します（0x4000）。

VT_BYREFは型ではなく、参照を示す型属性です。OLEオートメーションサーバが
結果を引数に戻す場合、参照先の型を示す値と論理和を取るために利用します。

• WIN32OLE::VARIANT

絞り込み条件を変える

WIN32OLE_METHOD#offset_vtbl -> Integer (18307.0)

• 2.5.0

• インスタンスメソッド

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

...出すために利用する関数ポインタのテーブルです。

@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#visible? -> bool (18307.0)

• 2.5.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_TYPE#visible? -> bool (18307.0)

• 2.5.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE_TYPE

WIN32OLE_TYPE.typelibs -> [String] (18307.0)

• 2.5.0

• 特異メソッド

システムに登録されているすべてのTypeLibのドキュメント文字列を取得します。

...メント文字列の配
列を返します。

Ruby-1.9.1からは、すべてのTypeLibのドキュメント文字列を取得するには、
WIN32OLE_TYPELIBオブジェクトを利用して、以下のように記述してくだ
さい。

WIN32OLE_TYPELIB.typelibs.map {|t| t.name}...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#library_name -> String (18307.0)

• 2.5.0

• インスタンスメソッド

TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。

...名前を取得します。

@return TypeLibの名前を文字列で返します。
@raise WIN32OLERuntimeError ドキュメント文字列が取得できなかった場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib.library_name # => Excel...

• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE_TYPELIB#visible? -> bool (18307.0)

• 2.5.0

• インスタンスメソッド

TypeLibの情報が公開情報かどうかを照会します。

...とみなして偽を返します。

@return TypeLibが公開可能であれば真を返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.visible? # => true...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB.typelibs -> [WIN32OLE_TYPELIB] (18307.0)

• 2.5.0

• 特異メソッド

システムに登録されているすべてのTypeLibを取得します。

...システムに登録されているすべてのTypeLibを取得します。

@return 登録されているすべてのTypeLibを元にWIN32OLE_TYPELIBオブジェクト
の配列を返します。

tlibs = WIN32OLE_TYPELIB.typelibs...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB (18007.0)

• 2.5.0

• クラス

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

...要求によって参照可能となりま
す。

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

=== サンプルコード

require 'win32ole'

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library'...

...rsion = 1.7
creatable classes:
Application: PROGID=Excel.Application.14
Chart: PROGID=Excel.Chart.8
Worksheet: PROGID=Excel.Sheet.8

ここでは、Excelのクラスのうち、WIN32OLE.newで作成可能なクラスを引
数で指定する名前（PROGID）と共に示しています。...

WIN32OLE_VARIABLE (18007.0)

• 2.5.0

• クラス

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

...す。

OLEオートメーションサーバは、定数（WIN32OLE.const_load）、メソッ
ド/プロパティ（WIN32OLE_METHOD）、イベント（WIN32OLE_EVENT）
のほかに変数をクライアントへ提供できます。WIN32OLE_VARIABLEクラスは、サー
バが提供する変数の...

...enumのメンバは定数として利用で
きます。

WIN32OLE_VARIABLEのオブジェクトは、WIN32OLE_TYPE#variablesメソッ
ドを利用して取得します。

=== サンプルコード

require 'win32ole'

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetTy...

...pe')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}=#{variable.value}"
end

実行結果は以下となります。

xlChart=-4109
xlDialogSheet=-4116
xlExcel4IntlMacroSheet=4
xlExcel4MacroSheet=3
xlWorksheet=-4167

@see WIN32OLE_TYPE#variables...

• WIN32OLE_EVENT
• WIN32OLE_METHOD

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

• 2.5.0

• 特異メソッド

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

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

@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で...

...。
@return libnameで指定したWIN32OLE_TYPELIBオブジェクトを返します。
@raise WIN32OLERuntimeError 引数で指定したTypeLibが見つかりません。

tlib1 = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib2 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C0...

...0000000046}')
tlib3 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C000-000000000046}', 1.7)
tlib4 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C000-000000000046}', 1, 7)
tlib5 = WIN32OLE_TYPELIB.new("C:\\WINDOWS\\SYSTEM32\\SHELL32.DLL")
puts tlib1.name # => 'Microsoft Excel 14.0 Object...

• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE_VARIABLE#value -> object | nil (9307.0)

• 2.5.0

• インスタンスメソッド

変数の値を取得します。

...このような定数値を返します。

@return この変数が持つ定数値。値を持たない場合はnilを返します。


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

• WIN32OLE_VARIABLE

WIN32OLE#ole_type -> WIN32OLE_TYPE | nil (9007.0)

• 2.5.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_TYPELIB#guid -> String (9007.0)

• 2.5.0

• インスタンスメソッド

TypeLibのGUIDを取得します。

...TypeLibのGUIDを取得します。

@return TypeLibのGUIDを文字列で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.guid # => '{00020813-0000-0000-C0...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#major_version -> Integer (9007.0)

• 2.5.0

• インスタンスメソッド

TypeLibのメジャーバージョン番号を取得します。

...取得します。

@return TypeLibのメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.major_version # => 1...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#minor_version -> Integer (9007.0)

• 2.5.0

• インスタンスメソッド

TypeLibのマイナーバージョン番号を取得します。

...取得します。

@return TypeLibのマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.minor_version # => 7...

• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE_TYPELIB#name -> String (9007.0)

• 2.5.0

• インスタンスメソッド

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

...どに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。

@return TypeLibのドキュメント文字列を返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library'...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#ole_classes -> [WIN32OLE_TYPE] (9007.0)

• 2.5.0

• インスタンスメソッド

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

...挙子）、構造体などがあります。

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

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

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#ole_types -> [WIN32OLE_TYPE] (9007.0)

• 2.5.0

• インスタンスメソッド

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

...挙子）、構造体などがあります。

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

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

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#path -> String (9007.0)

• 2.5.0

• インスタンスメソッド

TypeLibのパス名を取得します。

...、Windowsのパス名形式（ディレクトリ区切りは「\」）
です。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.path # => 'C:\...\EXCEL.EXE'

Typ...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#to_s -> String (9007.0)

• 2.5.0

• インスタンスメソッド

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

...どに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。

@return TypeLibのドキュメント文字列を返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library'...

• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE_TYPELIB#version -> Float (9007.0)

• 2.5.0

• インスタンスメソッド

TypeLibのバージョン番号を取得します。

...号、小数点
数部にマイナーバージョン番号を設定したFloatで返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.version # => 1.7...

• WIN32OLE_TYPELIB

WIN32OLE_VARIABLE#name -> String (9007.0)

• 2.5.0

• インスタンスメソッド

変数名を取得します。

...変数名を取得します。

@return 変数名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}" # => xlChart, xlDialogSheet, ...
end...

• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#ole_type -> String (9007.0)

• 2.5.0

• インスタンスメソッド

変数の型を取得します。

...返します。

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

OLEオートメーションの型名は、対応するWIN32OLE::VARIANTの定数の先...

• WIN32OLE::VARIANT
• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#ole_type_detail -> [String] (9007.0)

• 2.5.0

• インスタンスメソッド

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

...列で返します。

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で未定義なので変...

...eBits
UI4 [UI4] reserved

上例のように、WIN32OLE_VARIABLEで取得できる変数あるいはその元となる構造
体は、必ずしもOLEオートメーション互換データというわけではありません。こ
のようなデータはWIN32OLEからは利用できません。...

• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#to_s -> String (9007.0)

• 2.5.0

• インスタンスメソッド

変数名を取得します。

...変数名を取得します。

@return 変数名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}" # => xlChart, xlDialogSheet, ...
end...

• WIN32OLE_VARIABLE

絞り込み条件を変える

WIN32OLE_VARIABLE#varkind -> Integer (9007.0)

• 2.5.0

• インスタンスメソッド

変数の種類（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#[](key...) -> object (307.0)

• 2.5.0

• インスタンスメソッド

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

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

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

...を指定します。プロ
パティの特定に複数のキーが必要な場合は「,」で区切って列記します。

@return プロパティ値を返します。

fsys = WIN32OLE.new('Scripting.FileSystemObject')
fsys.Drives[:c].FreeSpace #=> Cドライブの空き容量...

• WIN32OLE

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

• 2.5.0

• インスタンスメソッド

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

...を指定します。引
数の順序は最左端の引数のインデックスを0とします。型の指定
には、WIN32OLE::VARIANTの定数を利用します。引数が不
要な場合は空配列を指定します。

このメソッドはCOMアーリ...

...返します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。

DISPID_CELLS = 238
include WIN32OLE::VARIANT
excel = WIN32OLE.new('Excel.Applicatio...

...sheet._setproperty(DISPID_CELLS, [1, 2, 'hello'], [VT_I2, VT_I2, VT_BSTR])
puts sheet._getproperty(DISPID_CELLS, [1, 2], [VT_I2, VT_I2]).value #=> 'hello'
workbook.Close(:SaveChanges => false)
excel.Quit

DISPIDはWIN32OLE_METHOD#dispidから取得できます。

@see WIN32OLE::VARIANT...

• WIN32OLE
• WIN32OLE::VARIANT

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

• 2.5.0

• インスタンスメソッド

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

...。型の指定には、
WIN32OLE::VARIANTの定数を利用します。引数が不要な場
合は空配列を指定します。

@return メソッドの返り値。ただし返り値を持たないメソッドの場合はnil。

@raise WIN32OLERuntimeError オートメ...

...= WIN32OLE.new('Excel.Application')
excel._invoke(302, [], []) # DISPID 302は、Quitメソッド

MFCの制約により、バイト配列の型情報は通常
WIN32OLE::VARIANT::VT_VARIANTとなります。このような場合に、バイト
配列を与えるつもりで

include WIN32OLE::...

...い。

include WIN32OLE::VARIANT
obj.method(DISPID, [[0, 1, 2, 3]], [VT_BYREF | VT_ARRAY | VT_UI1])

なお、VB6で作成したCOMコンポーネントのパラメータに配列を与える場合は、
WIN32OLE::VARIANT::VT_BYREFの指定が必須です。

DISPIDはWIN32OLE_METHOD#dispidから...

• WIN32OLE
• WIN32OLE::VARIANT

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

• 2.5.0

• インスタンスメソッド

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

...持たないメソッドの場合はnil。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
excel = WIN32OLE.new('Excel.Application')
workbook = excel.wor...

...:Password => 'secret')
excel.invoke(:Quit)

このリストは、以下の記述と同等です。

excel = WIN32OLE.new('Excel.Application')
workbook = excel.workbooks.Open(:FileName => 'c:\\users\\public\\test.xml',
:ReadOn...

• Hash
• WIN32OLE

絞り込み条件を変える

WIN32OLE#method_missing(id, *args) -> object | nil (307.0)

• 2.5.0

• インスタンスメソッド

WIN32OLE#invokeメソッドを実行します。

...WIN32OLE#invokeメソッドを実行します。

WIN32OLEのインスタンスに対して、このリファレンスに明記されていないメソッ
ドを呼び出した場合、OLEオートメーションサーバのメソッド（プロパティ）呼
び出しと解釈します。

@param...

...有効なシンボルではありません。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。

WIN32OLEはOLEオートメーションオブジェクトのメ...

...ソッド呼び出しを
method_missingを利用して実行します。このためWIN32OLEを継承するクラスを
作成してmethod_missingをオーバーライドする場合、superを呼び出してくださ
い。

@see WIN32OLE#invoke...

• WIN32OLE

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

• 2.5.0

• インスタンスメソッド

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

...ド名を文字列またはシンボルで指定します。

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

excel = WIN32OLE.new('Excel.Application')
excel.ole_respond_to?(:quit) #=> true
excel.ole_respond_to?(:exit) #=> false...

• WIN32OLE

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

• 2.5.0

• 特異メソッド

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

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

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

また、chmファイルのフル...

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

@param helpcontext obj引数にWIN32OLE_TYPEオブジェクトまたは
WIN32OLE_METHOD...

...ファイル
がインストールされていない場合 (failed to open
help file `ファイル名') に通知します。

excel = WIN32OLE.new('Excel.Application')
typeobj = excel.ole_obj_help
WIN32OLE.ole_show_help(typeobj) if typeobj.helpfile...

• WIN32OLE
• WIN32OLE_METHOD
• WIN32OLE_TYPE

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

• 2.5.0

• 定数

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

...p x # => 10 …… 呼び出しによって影響を受けない
p WIN32OLE::ARGV # => ['*', 110, 11] …… 結果はARGVの対応する引数に反映される
obj.Accm '+', 10, 11
p WIN32OLE::ARGV # => ['+', 21, 11]

直前のメソッド呼び出しが例外となった...

...場合、ARGVの設定内容は呼び出し前の
状態が保たれます。つまり、WIN32OLE自身がARGVの内容を消去するのは、メソッ
ド呼び出しに成功した場合のみです。このため最後のメソッド呼び出しが引数
にオブジェクトを返すタイプ...

...VB (OLE Automation server)
Public Sub GetInterface(ByRef obj)
Set Obj = New OleObject
End Sub

# Ruby
obj.GetInterface nil # 引数の数を合わせるためダミー引数を指定
WIN32OLE::ARGV.clear # 通常は、後続のメソッド呼び出しによって消去される...

• WIN32OLE

WIN32OLE_EVENT#handler -> object (307.0)

• 2.5.0

• インスタンスメソッド

WIN32OLE_EVENT#handler=メソッドで登録したイベントハンドラオブジェ クトを返します。

...WIN32OLE_EVENT#handler=メソッドで登録したイベントハンドラオブジェ
クトを返します。

@return イベントハンドラオブジェクト。未登録ならばnil。...

• WIN32OLE_EVENT

絞り込み条件を変える

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

• 2.5.0

• インスタンスメソッド

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

...ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
event.handler = IeHandler.new
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if event.handler.completed
WIN32OLE_EVENT.message_loop
end
ie.Quit

WIN32OLE_EVENT#...

• WIN32OLE_EVENT

WIN32OLE_METHOD#event? -> bool (307.0)

• 2.5.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_PARAM#default -> object | nil (307.0)

• 2.5.0

• インスタンスメソッド

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

...指定しなかった場合の既定値。必須パラメータならば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 "#{param.nam...

• WIN32OLE_PARAM

WIN32OLE_PARAM#input? -> bool (307.0)

• 2.5.0

• インスタンスメソッド

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

...OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out（サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout（クライアントからサーバ
へ与え、サーバがク...

...ます。

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

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

@see http://msd...

• WIN32OLE_PARAM

WIN32OLE_PARAM#optional? -> bool (307.0)

• 2.5.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?}" # =>...

• WIN32OLE_PARAM

絞り込み条件を変える

WIN32OLE_PARAM#output? -> bool (307.0)

• 2.5.0

• インスタンスメソッド

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

...OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out（サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout（クライアントからサーバ
へ与え、サーバがク...

...す。

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

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'DWebBrowserEvents')
method = WIN32OLE_METHOD.new(tobj, 'NewWindow')
method.params.each do |param|
puts "#{param.name} #{param.output?}...

• WIN32OLE_PARAM

WIN32OLE_PARAM#retval? -> bool (307.0)

• 2.5.0

• インスタンスメソッド

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

...ます。

OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性（WIN32OLE_PARAM#output?が真）とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述す...

...ータが戻り値として扱われる場合に真を返します。

tobj = WIN32OLE_TYPE.new('DirectX 7 for Visual Basic Type Library',
'DirectPlayLobbyConnection')
method = WIN32OLE_METHOD.new(tobj, 'GetPlayerShortName')
param = method.params[0]
puts "#{pa...

• WIN32OLE_PARAM

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

• 2.5.0

• 特異メソッド

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

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

@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で指...

...ypeLIbに定義された型の情報を格納したWIN32OLE_TYPEオブジェクトを返します。
@raise WIN32OLERuntimeError TypeLibが見つかりません。またはole_classで指定した型が未定義です。

excel_app_type = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'A...

...pplication')
puts excel_app_type.progid # => "Excel.Application.14"

TypeLibに定義されているすべての型を取得するには、
WIN32OLE_TYPELIBオブジェクトのWIN32OLE_TYPELIB#ole_typesメ
ソッドを利用します。...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPE.ole_classes(libname) -> [WIN32OLE_TYPE] (307.0)

• 2.5.0

• 特異メソッド

TypeLibで定義されているすべての型情報を取得します。

...（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で指定します。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェクトの配列として返します。
@raise WIN32OLERun...

...types = WIN32OLE_TYPE.ole_classes('Microsoft Excel 14.0 Object Library')
classes = types.map{|k| k.name} # => ["Adjustments", "CalloutFormat", ...]

Ruby-1.9.1からは、TypeLibに定義されているすべての型を取得するには、
WIN32OLE_TYPELIBオブジェクトのWIN32OLE_TYPELIB...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

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

• 2.5.0

• インスタンスメソッド

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

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

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

@param i 各次元の0からのインデックスを「,」で区切って次元数分...

...ていません。

@raise WIN32OLERuntimeError selfが配列型のWIN32OLE_VARIANTではありませ
ん。あるいはインデックスが0未満または要素数
以上を指定しています。

obj = WIN32OLE_VARIANT.new([[1,2,3],[4,...

...5,6]])
p obj[0,0] # => 1
p obj[1,0] # => 4
p obj[2,0] # => WIN32OLERuntimeError
p obj[0, -1] # => WIN32OLERuntimeError...

• WIN32OLE_VARIANT

絞り込み条件を変える

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

• 2.5.0

• インスタンスメソッド

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

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

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

@param i 各次元の0からのインデックスを「,」で区切って次元数分...

...ンオブジェクト（WIN32OLEオブジェクト）に変換します。
@return 引数で指定したインデックスの要素を返します。
@raise ArgError 引数の数が次元数と一致していません。

@raise WIN32OLERuntimeError selfが配列型のWIN32OLE_VARIANTではありま...

...が0未満または要素数
以上を指定しています。

obj = WIN32OLE_VARIANT.new([[1,2,3],[4,5,6]])
obj[0,0] = 7
obj[1,0] = 8
p obj.value # => [[7,2,3], [8,5,6]]
obj[2,0] = 9 # => WIN32OLERuntimeError
obj[0, -1] = 9 # => WIN32OLERuntimeError...

• WIN32OLE_VARIANT

WIN32OLE_VARIANT#value -> object (307.0)

• 2.5.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE_VARIANT

WIN32OLE_EVENT (61.0)

• 2.5.0

• クラス

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

...ベント」と呼びます。WIN32OLE_EVENTを利用
すると、ブロックの形式でイベントを受け取るメソッドをサーバへ登録できま
す。

=== サンプルコード

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

...nt.getElementsByTagName('a').each do |e|
puts "#{e.innerHTML}=#{e.href}" #=> ダウンロード=http://www.ruby-lang.org/ja/downloads/ など
end
disp.quit
b = true
end
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if b
WIN32OLE_EVENT.message_loop
end...

WIN32OLE_EVENT.message_loop -> () (61.0)

• 2.5.0

• 特異メソッド

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

...ト処理は
Windowsメッセージを読み取ってディスパッチすることで通知されます。

ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
b = false
event.on_event('DocumentComplete') do |disp, uri|
disp.document....

...by-lang.org/ja/downloads/ など
end
disp.quit
b = true
end
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if b
WIN32OLE_EVENT.message_loop
end

なお、メソッド名はloopですが、呼び出し時および既にキューイングされたメッ
セージ...

• WIN32OLE_EVENT

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

• 2.5.0

• インスタンスメソッド

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

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

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

なおデフォルトプロパ...

...に設定する値を指定します。

@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。

dict = WIN32OLE.new('Scripting.Dictionary')
dict[:a] = 0x41
d...

• WIN32OLE

絞り込み条件を変える

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (43.0)

• 2.5.0

• インスタンスメソッド

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

...（イ
ベントの通知元となるインターフェイス）を返します。

@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大...

...bj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
tobj.default_event_sources.map {|intf| intf.name} #=> ["DocEvents"]

WIN32OLE_EVENT.newでインターフェイス名を指定しない場合は、ここで
返されたインターフェイスが選択されます。

次...

...るために、
WIN32OLE_EVENT.message_loopの呼び出しが必要な点に注意してください。
ここでは最終イベントのStatusTextChangeイベントのメッセージについては既
知としています。

# coding : cp932
require 'win32ole'

type = WIN32OLE_TYPE.new('Micro...

• WIN32OLE_TYPE

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

• 2.5.0

• インスタンスメソッド

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

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

ie = WIN32OLE.new('InternetExplorer.Application')
ie_web_app = ie.ole_query_inter...

...たOLEオートメーションサーバでは本メソッドが意味
を持つことはありません。というのは、2つ以上の異なるWIN32OLEで操作可能な
インターフェイスを持つということは、IID_IDispatch（OLEオートメーション
のインターフェイスID...

...っているため、静的に型を解決して
いる場合は、追加のメソッドの呼び出しを記述できません。

しかし、WIN32OLEが利用するIDispatchインターフェイスは、メソッド名による
動的なメソッド検索が行われます。このため、Soluti...

• WIN32OLE

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

• 2.5.0

• インスタンスメソッド

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

...ます。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESUL...

...のため、次の例のようにsetpropertyメソッドを利用して、パラメータ付きプ
ロパティを設定します。


excel = WIN32OLE.new('Excel.Application')
excel.visible = true
sheet = excel.Workbooks.Add.Worksheets[1]
sheet.setproperty(:Cells, 1, 2, 32)
sheet.set...

• WIN32OLE

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

• 2.5.0

• インスタンスメソッド

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

...ます。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESUL...

...のため、次の例のようにsetpropertyメソッドを利用して、パラメータ付きプ
ロパティを設定します。


excel = WIN32OLE.new('Excel.Application')
excel.visible = true
sheet = excel.Workbooks.Add.Worksheets[1]
sheet.setproperty(:Cells, 1, 2, 32)
sheet.set...

• WIN32OLE