検索結果

WIN32OLE_METHOD#helpstring -> String | nil (46264.0)

• 2.1.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#default_event_sources -> [WIN32OLE_TYPE] (45946.0)

• 2.1.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_METHOD#return_type_detail -> [String] (45682.0)

• 2.1.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#event_interface -> String | nil (45664.0)

• 2.1.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_METHOD#return_type -> String (45664.0)

• 2.1.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_vtype -> Integer (45664.0)

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

• 2.1.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_missing(id, *args) -> object | nil (36949.0)

• 2.1.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#params -> [WIN32OLE_PARAM] (36664.0)

• 2.1.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 # => [Filename, FileFormat, Password, WriteResPassword,
ReadOnlyRecommended, CreateBackup, AccessMode,
ConflictResolution, AddToMru, TextCodepa...

• WIN32OLE_METHOD
• WIN32OLE_PARAM

WIN32OLE_METHOD#size_params -> Integer | nil (36664.0)

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

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

• 2.1.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#_setproperty(dispid, args, types) -> () (36628.0)

• 2.1.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

WIN32OLE_METHOD#helpcontext -> Integer | nil (27982.0)

• 2.1.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_METHOD#offset_vtbl -> Integer (27664.0)

• 2.1.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#to_s -> String (27664.0)

• 2.1.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#default -> object | nil (27664.0)

• 2.1.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#ole_type -> String (27664.0)

• 2.1.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] (27664.0)

• 2.1.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#input? -> bool (27364.0)

• 2.1.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 (27364.0)

• 2.1.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 (27364.0)

• 2.1.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_EVENT#handler=(obj) -> () (27346.0)

• 2.1.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#invoke_kind -> String (18700.0)

• 2.1.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#helpfile -> String | nil (18682.0)

• 2.1.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#dispid -> Integer (18664.0)

• 2.1.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#invkind -> Integer (18664.0)

• 2.1.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#name -> String (18664.0)

• 2.1.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#to_s -> String (18664.0)

• 2.1.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_PARAM#name -> String (9664.0)

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

• 2.1.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