ライブラリ
- win32ole (38)
クラス
- WIN32OLE (9)
-
WIN32OLE
_ METHOD (18) -
WIN32OLE
_ PARAM (9) -
WIN32OLE
_ TYPE (2)
キーワード
-
_ getproperty (1) -
_ invoke (1) -
_ setproperty (1) - default (1)
-
default
_ event _ sources (1) - dispid (1)
- event? (1)
-
event
_ interface (1) - helpcontext (1)
- helpfile (1)
- helpstring (1)
- input? (1)
- invkind (1)
-
invoke
_ kind (1) - name (2)
-
offset
_ vtbl (1) -
ole
_ func _ methods (1) -
ole
_ get _ methods (1) -
ole
_ method _ help (1) -
ole
_ methods (2) -
ole
_ put _ methods (1) -
ole
_ type (1) -
ole
_ type _ detail (1) - optional? (1)
- output? (1)
- params (1)
-
return
_ type (1) -
return
_ type _ detail (1) -
return
_ vtype (1) - retval? (1)
-
size
_ opt _ params (1) -
size
_ params (1) -
to
_ s (2) - visible? (1)
検索結果
先頭5件
-
WIN32OLE
# ole _ method(method) -> WIN32OLE _ METHOD (73300.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発... -
WIN32OLE
_ TYPE # ole _ methods -> [WIN32OLE _ METHOD] (46243.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 # return _ type _ detail -> [String] (45640.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
_ PARAM # ole _ type _ detail -> [String] (45622.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", "USERDEFINED", "Range"]
パラメータの取り得る属性値はCOMのIDL(インターフ... -
WIN32OLE
# ole _ method _ help(method) -> WIN32OLE _ METHOD (37300.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発... -
WIN32OLE
# ole _ methods -> [WIN32OLE _ METHOD] (37291.0) -
オブジェクトのメソッド情報をWIN32OLE_METHODの配列として返します。
オブジェクトのメソッド情報をWIN32OLE_METHODの配列として返します。
ole_methodsメソッドは、OLEオートメーションサーバが提供するすべてのメソッ
ドをWIN32OLE_METHODの配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE.new('Excel.Appli... -
WIN32OLE
_ METHOD # invoke _ kind -> String (36358.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 # size _ opt _ params -> Integer | nil (36322.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 # size _ params -> Integer | nil (36322.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 # helpcontext -> Integer | nil (27340.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 # helpfile -> String | nil (27340.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 # event? -> bool (27322.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 (27322.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 # helpstring -> String | nil (27322.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 # name -> String (27322.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 (27322.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 # return _ type -> String (27322.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
_ METHOD # return _ vtype -> Integer (27322.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 # visible? -> bool (27322.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 # ole _ type -> String (27322.0) -
パラメータの型名を取得します。
パラメータの型名を取得します。
@return パラメータの型名を示す文字列を返します。
パラメータの型情報が見つからない場合は、"unknown type"を返します。
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
# ole _ func _ methods -> [WIN32OLE _ METHOD] (18991.0) -
オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し ます。
オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し
ます。
ole_func_methodsメソッドは、OLEオートメーションサーバのメソッドのうちファ
ンクション(何らかの機能的な操作)に属するものをWIN32OLE_METHODの
配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
exc... -
WIN32OLE
# ole _ get _ methods -> [WIN32OLE _ METHOD] (18991.0) -
オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として 返します。
オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として
返します。
ole_get_methodsメソッドは、OLEオートメーションサーバのメソッドのうち読
み取り可能なプロパティをWIN32OLE_METHODの配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE... -
WIN32OLE
# ole _ put _ methods -> [WIN32OLE _ METHOD] (18991.0) -
オブジェクトの設定可能プロパティ情報をWIN32OLE_METHODの配列として 返します。
オブジェクトの設定可能プロパティ情報をWIN32OLE_METHODの配列として
返します。
ole_put_methodsメソッドは、OLEオートメーションサーバのメソッドのうちプ
ロパティ設定メソッドに属するものをWIN32OLE_METHODの配列として返し
ます。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = W... -
WIN32OLE
# _ getproperty(dispid , args , types) -> object (18322.0) -
DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。
DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。
アクセスするプロパティのインターフェイスを事前に知っている場合に、
DISPIDとパラメータの型を指定してプロパティを参照します。
@param dispid プロパティのDISPID(メソッドを一意に特定する数値)を指定
します。
@param args プロパティが引数を取る場合に配列で指定します。引数の順序は
最左端の引数のインデックスを0とします。引数が不要な場合は空
配列を指定します。
@param types プロパティが... -
WIN32OLE
# _ invoke(dispid , args , types) -> object | nil (18322.0) -
DISPIDとパラメータの型を指定してオブジェクトのメソッドを呼び出します。
DISPIDとパラメータの型を指定してオブジェクトのメソッドを呼び出します。
呼び出すメソッドのインターフェイスを事前に知っている場合に、DISPIDとパ
ラメータの型を指定してメソッドを呼び出します。
このメソッドは引数の変換方法をプログラマが制御できるようにすることと、
COMアーリーバインディングを利用して外部プロセスサーバとのラウンドトリッ
プを減らして処理速度を向上させることを目的としたものです。後者の目的に
ついては、DLLの形式で型情報(TypeLib)を提供しているサーバに対してはあ
まり意味を持ちません。そのため、型の高精度な制御が不要な場合は、直接メ
ソッド名を指定した... -
WIN32OLE
# _ setproperty(dispid , args , types) -> () (18322.0) -
DISPIDとパラメータの型を指定してオブジェクトのプロパティを設定します。
DISPIDとパラメータの型を指定してオブジェクトのプロパティを設定します。
アクセスするプロパティのインターフェイスを事前に知っている場合に、
DISPIDとパラメータの型を指定してプロパティを設定します。
このメソッドはCOMアーリーバインディングを利用することで外部プロセスサー
バとのラウンドトリップを減らして処理速度を向上させることを目的としたも
のです。このため、DLLの形式で型情報(TypeLib)を提供しているサーバに対
してはあまり意味を持ちません。
@param dispid プロパティのDISPID(メソッドを一意に特定する数値)を指定
し... -
WIN32OLE
_ METHOD # dispid -> Integer (18322.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 # invkind -> Integer (18322.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 # params -> [WIN32OLE _ PARAM] (18322.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
_ PARAM # default -> object | nil (18322.0) -
パラメータを指定しなかった場合の既定値を取得します。
パラメータを指定しなかった場合の既定値を取得します。
当パラメータが必須パラメータの場合はnilを返します。
@return パラメータを指定しなかった場合の既定値。必須パラメータならば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 "... -
WIN32OLE
_ PARAM # name -> String (18322.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 # => Filename -
WIN32OLE
_ PARAM # retval? -> bool (18322.0) -
パラメータが戻り値かどうかを判定します。
パラメータが戻り値かどうかを判定します。
OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性(WIN32OLE_PARAM#output?が真)とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述する言語
が戻り値のように扱うか、それとも引数リストに並べるかはretval属性によっ
て決定されます。
retval?メソッドは、戻り値として記述する場合に真となります。
@return パラメータが戻り値として扱われる場合に真を返します。
tobj = WIN32OLE_TYPE.new('DirectX... -
WIN32OLE
_ TYPE # default _ event _ sources -> [WIN32OLE _ TYPE] (18322.0) -
型が持つソースインターフェイスを取得します。
型が持つソースインターフェイスを取得します。
default_event_sourcesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスがサポートするデフォルトのソースインターフェイス(イ
ベントの通知元となるインターフェイス)を返します。
@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。
tobj = ... -
WIN32OLE
_ METHOD # to _ s -> String (18022.0) -
メソッド名を取得します。
メソッド名を取得します。
@return メソッド名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs -
WIN32OLE
_ PARAM # input? -> bool (9022.0) -
パラメータがクライアントからサーバへ与えるものかを判定します。
パラメータがクライアントからサーバへ与えるものかを判定します。
OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。
input?メソッドはin属性またはinout属性なら真を返します。
@return メソッドの方向属性がinまたはinoutならば真を返します。
tobj = WIN32OLE... -
WIN32OLE
_ PARAM # optional? -> bool (9022.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?}" # => Filename true -
WIN32OLE
_ PARAM # output? -> bool (9022.0) -
パラメータがクライアントからの結果を受け取るためのものかを判定します。
パラメータがクライアントからの結果を受け取るためのものかを判定します。
OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。
output?メソッドはout属性またはinout属性なら真を返します。
@return メソッドの方向属性がoutまたはinoutならば真を返します。
tobj = W... -
WIN32OLE
_ PARAM # to _ s -> String (9022.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 # => Filename