検索結果

WIN32OLE_METHOD (132037.0)

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

• 2.2.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_METHOD#helpfile -> String | nil (81373.0)

• 2.2.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_METHOD#helpstring -> String | nil (81337.0)

• 2.2.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.new(ole_type, method) -> WIN32OLE_METHOD (73096.0)

• 2.2.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_METHOD#invoke_kind -> String (72091.0)

• 2.2.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 (72073.0)

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

• 2.2.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_METHOD#return_vtype -> Integer (72073.0)

• 2.2.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#dispid -> Integer (72055.0)

• 2.2.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_METHOD#event? -> bool (72055.0)

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

• 2.2.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#invkind -> Integer (72037.0)

• 2.2.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 (72037.0)

• 2.2.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 (72037.0)

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

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

• 2.2.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 (72037.0)

• 2.2.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 (72037.0)

• 2.2.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 (72037.0)

• 2.2.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#ole_method(method) -> WIN32OLE_METHOD (19327.0)

• 2.2.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_METHOD

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE#ole_func_methods -> [WIN32OLE_METHOD] (19042.0)

• 2.2.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] (19042.0)

• 2.2.0

• インスタンスメソッド

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

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

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

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

excel = WIN32OLE...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE#ole_methods -> [WIN32OLE_METHOD] (19042.0)

• 2.2.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_put_methods -> [WIN32OLE_METHOD] (19042.0)

• 2.2.0

• インスタンスメソッド

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

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

ole_put_methodsメソッドは、OLEオートメーションサーバのメソッドのうちプ
ロパティ設定メソッドに属するものをWIN32OLE_METHODの配列として返し
ます。

@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。

excel = W...

• WIN32OLE
• WIN32OLE_METHOD

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (18976.0)

• 2.2.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.ole_show_help(obj, helpcontext = nil) -> () (18391.0)

• 2.2.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_PARAM.new(ole_method, index) -> WIN32OLE_PARAM (463.0)

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