検索結果

WIN32OLE_METHOD#helpstring -> String | nil (37210.0)

• 2.3.0

• インスタンスメソッド

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

...明する文字列です。

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

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

• WIN32OLE_METHOD

WIN32OLE_TYPE#helpstring -> String | nil (37210.0)

• 2.3.0

• インスタンスメソッド

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

...メント文字列を取得します。

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

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

ドキュメント文字列は、コ...

• WIN32OLE_TYPE

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

• 2.3.0

• インスタンスメソッド

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

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

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

@param event イベント名を文字列か...

...配列の形式で受けてください。

@raise WIN32OLERuntimeError WIN32OLE_EVENT#unadviseによってイベン
トソースと切断済みです。

ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
ev.on_event...

• WIN32OLE_EVENT

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

• 2.3.0

• インスタンスメソッド

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

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

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

@param...

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

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

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

@see WIN32OLE#invoke...

• WIN32OLE

WIN32OLE_METHOD#event_interface -> String | nil (27910.0)

• 2.3.0

• インスタンスメソッド

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

...ベントのインターフェイス名を返し
ます。イベントでなければ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#ole_get_methods -> [WIN32OLE_METHOD] (27610.0)

• 2.3.0

• インスタンスメソッド

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

...報をWIN32OLE_METHODの配列として
返します。

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

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeEr...

...xcel = WIN32OLE.new('Excel.Application')
excel.ole_get_methods.each do |prop|
begin
puts "#{prop.name}=#{excel._getproperty(prop.dispid, [], [])}"
rescue WIN32OLERuntimeError
puts "can't read #{prop.name} property"
end
end

@see WIN32OLE#ole_methods, WIN32OLE#ole_f...

...unc_methods,
WIN32OLE#ole_put_methods...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE_TYPE#guid -> String | nil (27610.0)

• 2.3.0

• インスタンスメソッド

この型の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のク...

• WIN32OLE_TYPE

WIN32OLE_TYPE#progid -> String | nil (27610.0)

• 2.3.0

• インスタンスメソッド

selfのPROGIDを取得します。

...リ登録名です。WIN32OLE.newの引数に指定して
WIN32OLEオブジェクトを生成できます。

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

tobj = WIN32OLE_TYPE.new('Microsoft Exc...

...el 14.0 Object Library', 'Application')
p tobj.progid # => "Excel.Application.14"

この例は、ExcelのApplicationクラスが「Excel.Application.14」という
PROGIDを持つことを示します。

@see WIN32OLE.new...

• WIN32OLE_TYPE

WIN32OLE_TYPELIB#guid -> String (27610.0)

• 2.3.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#_getproperty(dispid, args, types) -> object (27310.0)

• 2.3.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_METHOD#helpcontext -> Integer | nil (18910.0)

• 2.3.0

• インスタンスメソッド

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

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

WIN32OLE_METHODオブジェクトを引数として、WIN32OLE.ole_show_helpで
ヘルプファイルを表示する場合には、WIN32OLEが...

...内部で当メソッドを呼び出し
ます。

@see WIN32OLE.ole_show_help...

• WIN32OLE_METHOD

WIN32OLE_TYPE#helpcontext -> Integer | nil (18910.0)

• 2.3.0

• インスタンスメソッド

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

...。

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

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

• WIN32OLE_TYPE

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

• 2.3.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 (18610.0)

• 2.3.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_EVENT#on_event(event = nil) {|*args| ... } -> () (18610.0)

• 2.3.0

• インスタンスメソッド

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

...は、
WIN32OLE_EVENT#on_event_with_outargsを利用してください。

@raise WIN32OLERuntimeError WIN32OLE_EVENT#unadviseによってイベン
トソースと切断済みです。

ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT....

...、通知されたイベントに対応するブロックがあれば
そちらだけが呼び出されます。

ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
ev.on_event("NavigateComplete2") do |browser, url|
puts url
end
ev.on_e...

• WIN32OLE_EVENT

絞り込み条件を変える

WIN32OLE_METHOD#invkind -> Integer (18610.0)

• 2.3.0

• インスタンスメソッド

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

...きかを指定した属性値で
す。

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

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

INVOKEKIND列挙値は以下の通りです。メソ...

• WIN32OLE_METHOD

WIN32OLE_METHOD#invoke_kind -> String (18610.0)

• 2.3.0

• インスタンスメソッド

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

...字列を返します。

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

返送値は以下のいずれかとなります。値の意味は
WIN32OLE_METHOD#invkindの説明を参照...

...ています。
: PROPERTYPUT
INVOKE_PROPERTYPUTが設定されています。
: PROPERTYPUTREF
INVOKE_PROPERTYPUTREFが設定されています。
: FUNC
INVOKE_FUNCが設定されています。
: UNKNOWN
上記のいずれにも当てはまりません。

@see WIN32OLE_METHOD#invkind...

• WIN32OLE_METHOD

WIN32OLE_METHOD#name -> String (18610.0)

• 2.3.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#return_type -> String (18610.0)

• 2.3.0

• インスタンスメソッド

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

...名を示す文字列を返します。
@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::VARIANTの定数の先
頭の「VT_」を削除した名称を持ちます。

たとえば、32ビット符号付き整数であれば「I4」となります。

@see WIN32OLE::VARIANT...

• WIN32OLE::VARIANT
• WIN32OLE_METHOD

WIN32OLE_METHOD#return_type_detail -> [String] (18610.0)

• 2.3.0

• インスタンスメソッド

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

...します。

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_METHOD#return_vtype -> Integer (18610.0)

• 2.3.0

• インスタンスメソッド

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

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

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Visible')
puts method.retur...

• WIN32OLE_METHOD

WIN32OLE_PARAM#name -> String (18610.0)

• 2.3.0

• インスタンスメソッド

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

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

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#inspect -> String (18610.0)

• 2.3.0

• インスタンスメソッド

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#major_version -> Integer (18610.0)

• 2.3.0

• インスタンスメソッド

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

...取得します。

@return 型のメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。

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

• WIN32OLE_TYPE

WIN32OLE_TYPE#minor_version -> Integer (18610.0)

• 2.3.0

• インスタンスメソッド

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

...取得します。

@return 型のマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。

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

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#name -> String (18610.0)

• 2.3.0

• インスタンスメソッド

selfの型名を取得します。

...selfの型名を取得します。

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

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

• WIN32OLE_TYPE

WIN32OLE_TYPE#typekind -> Integer (18610.0)

• 2.3.0

• インスタンスメソッド

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

...。

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

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

tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Objec...

...t Library', 'Documents')
p tobj.typekind # => 4

@see WIN32OLE_TYPE#ole_type...

• WIN32OLE_TYPE

WIN32OLE_TYPELIB#library_name -> String (18610.0)

• 2.3.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#major_version -> Integer (18610.0)

• 2.3.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 (18610.0)

• 2.3.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 (18610.0)

• 2.3.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_VARIABLE#name -> String (18610.0)

• 2.3.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#variable_kind -> String (18610.0)

• 2.3.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#varkind -> Integer (18610.0)

• 2.3.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#setproperty(name, args..., val) -> () (9610.0)

• 2.3.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_METHOD#dispid -> Integer (9610.0)

• 2.3.0

• インスタンスメソッド

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

...す。WIN32OLEでは、
WIN32OLE#_invokeなどのメソッドで、呼び出すサーバのメソッドを指定
するのに利用します。

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

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHO...

...D.new(tobj, 'Add')
puts method.dispid # => 181

@see WIN32OLE#_invoke, WIN32OLE#_getproperty,
WIN32OLE#_setproperty...

• WIN32OLE_METHOD

WIN32OLE_METHOD#helpfile -> String | nil (9610.0)

• 2.3.0

• インスタンスメソッド

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

...。

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

メソッドにヘルプファイルが関連付けられている場合、WIN32OLE.ole_show_helpにWIN32OLE_METHODオブ...

...ジェクトを与えてヘルプファイルを表示できます。

@see WIN32OLE.ole_show_help...

• WIN32OLE_METHOD

WIN32OLE_METHOD#offset_vtbl -> Integer (9610.0)

• 2.3.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#size_opt_params -> Integer | nil (9610.0)

• 2.3.0

• インスタンスメソッド

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

...パラメータ数を整数で返します。メソッドの詳細情報を取
得できない場合は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 (9610.0)

• 2.3.0

• インスタンスメソッド

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

...パラメータ数を整数で返します。メソッドの詳細情報を取得できない
場合は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 (9610.0)

• 2.3.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_PARAM#ole_type -> String (9610.0)

• 2.3.0

• インスタンスメソッド

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

...返します。

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の定数の先
頭...

...の「VT_」を削除した名称を持ちます。

たとえば、32ビット符号付き整数であれば「I4」となります。

@see WIN32OLE::VARIANT...

• WIN32OLE::VARIANT
• WIN32OLE_PARAM

WIN32OLE_PARAM#ole_type_detail -> [String] (9610.0)

• 2.3.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", "USER...

• WIN32OLE_PARAM

WIN32OLE_PARAM#to_s -> String (9610.0)

• 2.3.0

• インスタンスメソッド

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

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

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#helpfile -> String | nil (9610.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

@ret...

...未定義の場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpfile # => C:\...\VBAXL9.CHM
WIN32OLE.ole_show_help tobj.helpfile, tobj.helpcontext
# 注）WIN32OLE.ole_show_help(tobj) の呼び出しが望ましい...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#ole_type -> String | nil (9610.0)

• 2.3.0

• インスタンスメソッド

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

...取得します。

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

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

ole_typeには以下があります。

: Enum
列...

...コンポーネントクラス（InterfaceやDispatchの実装）（5）
: Alias
他の型の別名（6）
: Union
共用体（7）
: Max
型の種類を示す列挙体の終端マーカ（8）

MaxはTYPEKINDの終端マーカなので意味を持ちません。

@see WIN32OLE_TYPE#typekind...

• WIN32OLE_TYPE

WIN32OLE_TYPE#src_type -> String | nil (9610.0)

• 2.3.0

• インスタンスメソッド

selfが他の型の別名ならば、元の型名を取得します。

...ます。

@return selfが別名ならば元の型名を文字列で返します。別名でなければnilを
返します。

tobj = WIN32OLE_TYPE.new('Microsoft Office 14.0 Object Library', 'MsoRGBType')
p tobj.src_type # => "I4"

この例は、OfficeのMsoRGBType型は符号付...

• WIN32OLE_TYPE

WIN32OLE_TYPE#to_s -> String (9610.0)

• 2.3.0

• インスタンスメソッド

selfの型名を取得します。

...selfの型名を取得します。

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

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

• WIN32OLE_TYPE

WIN32OLE_TYPELIB#path -> String (9610.0)

• 2.3.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 (9610.0)

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

• 2.3.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] (9610.0)

• 2.3.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 (9610.0)

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

• 2.3.0

• インスタンスメソッド

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_U...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

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

• 2.3.0

• インスタンスメソッド

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

...
WIN32OLE::VARIANTの定数を利用します。

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

DISPID_CELLS = 238
include WIN32OLE::VA...

...RIANT
excel = WIN32OLE.new('Excel.Application')
puts excel._setproperty(558, # VisibleプロパティのDISPIDは558
[true], [VT_BOOL])
workbook = excel.Workbooks.Add
sheet = workbook.Worksheets[1]
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

絞り込み条件を変える