るりまサーチ (Ruby 2.6.0)

最速Rubyリファレンスマニュアル検索!
32件ヒット [1-32件を表示] (0.058秒)
トップページ > バージョン:2.6.0[x] > クエリ:Object[x] > クエリ:OBJECT[x] > クエリ:Method[x] > クエリ:method[x] > ライブラリ:win32ole[x]

別のキーワード

  1. objectspace each_object
  2. _builtin each_object
  3. object define_singleton_method
  4. object to_enum
  5. object enum_for

検索結果

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (37321.0)

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

...タを取得します。

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


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

@see WIN32OLE_METHOD...

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

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

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

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

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

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

@see WIN32OLE#invoke...

WIN32OLE_METHOD.new(ole_type, method) -> WIN32OLE_METHOD (19675.0)

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

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

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

アプリケーションプログラムでは、WIN32OLE_METHO...
...WIN32OLE#ole_methodなどのメソッドを参照するほ
うが簡単です。

@param ole_type WIN32OLE_TYPEのインスタンス。
@param method メソッド名を文字列で指定します。
@return methodパラメータに対応するWIN32OLE_METHODのインスタンス。
@raise WIN32OLERu...
...ntimeError methodパラメータで指定したメソッドが見つかりません。

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

WIN32OLE_METHOD#invoke_kind -> String (18223.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#helpcontext -> Integer | nil (18187.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#helpfile -> String | nil (18187.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#return_type_detail -> [String] (18187.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#dispid -> Integer (18151.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#event? -> bool (18151.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_METHOD#event_interface -> String | nil (18151.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#invkind -> Integer (18151.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#name -> String (18151.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#offset_vtbl -> Integer (18151.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#params -> [WIN32OLE_PARAM] (18151.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#return_type -> String (18151.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_METHOD#return_vtype -> Integer (18151.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#size_opt_params -> Integer | nil (18151.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#size_params -> Integer | nil (18151.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#to_s -> String (18151.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#visible? -> bool (18151.0)

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

...て公開されているか(可視性を持つか)ど
うかを返します。

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

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

絞り込み条件を変える

WIN32OLE_PARAM#default -> object | nil (757.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#_invoke(dispid, args, types) -> object | nil (721.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#_getproperty(dispid, args, types) -> object (649.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_PARAM (223.0)

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

...メータ情報を提供します。

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

=== サンプルコード

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

@see WIN32OLE_METHOD...

WIN32OLE_PARAM#input? -> bool (151.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#name -> String (151.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#ole_type -> String (151.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_PARAM#ole_type_detail -> [String] (151.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#optional? -> bool (151.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#to_s -> String (151.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_TYPE#default_event_sources -> [WIN32OLE_TYPE] (115.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_VARIABLE (79.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...