ライブラリ
- win32ole (39)
クラス
-
WIN32OLE
_ METHOD (8) -
WIN32OLE
_ PARAM (9) -
WIN32OLE
_ TYPE (6) -
WIN32OLE
_ TYPELIB (8) -
WIN32OLE
_ VARIABLE (8)
キーワード
- default (1)
-
default
_ event _ sources (1) -
default
_ ole _ types (1) -
event
_ interface (1) - helpstring (1)
- input? (1)
-
library
_ name (1) -
major
_ version (2) - name (5)
-
ole
_ classes (1) -
ole
_ type _ detail (2) -
ole
_ types (1) - optional? (1)
- output? (1)
- params (1)
- path (1)
-
return
_ type _ detail (1) - retval? (1)
-
size
_ opt _ params (1) -
size
_ params (1) -
to
_ s (5) - value (1)
-
variable
_ kind (1) - variables (1)
- varkind (1)
- version (1)
- visible? (1)
検索結果
先頭5件
-
WIN32OLE
_ PARAM # ole _ type -> String (72643.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
_ VARIABLE # ole _ type -> String (72643.0) -
変数の型を取得します。
変数の型を取得します。
@return 変数の型名を文字列で返します。型名を文字列に変換できない場合は、
「Unknown Type nn」(nnはバリアント型を示す数値)の形式の文字列
を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.ole_type} #{variabl... -
WIN32OLE
_ TYPE # default _ ole _ types -> [WIN32OLE _ TYPE] (55243.0) -
型が持つデフォルトのインターフェイスを取得します。
型が持つデフォルトのインターフェイスを取得します。
default_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)の場
合、そのクラスが実装しているデフォルトのインターフェイスと、サポートし
ていればデフォルトのソースインターフェイスを返します。
@return デフォルトインターフェイスをWIN32OLE_TYPEの配列として返し
ます。デフォルトインターフェイスは、最大でも、クラス操作用のイ
ンターフェイス(OLEオートメーション用)と、イベント用のソースイ
ンターフェイスの2要素です。デフォルトインターフ... -
WIN32OLE
_ TYPE # default _ event _ sources -> [WIN32OLE _ TYPE] (46033.0) -
型が持つソースインターフェイスを取得します。
型が持つソースインターフェイスを取得します。
default_event_sourcesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスがサポートするデフォルトのソースインターフェイス(イ
ベントの通知元となるインターフェイス)を返します。
@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。
tobj = ... -
WIN32OLE
_ VARIABLE # ole _ type _ detail -> [String] (45961.0) -
変数の型と属性を取得します。
変数の型と属性を取得します。
@return 変数の型と属性を文字列配列で返します。
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で未定義なので変換でき... -
WIN32OLE
_ PARAM # ole _ type _ detail -> [String] (45943.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
_ METHOD # event _ interface -> String | nil (45922.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
_ TYPE # major _ version -> Integer (45622.0) -
型のメジャーバージョン番号を取得します。
型のメジャーバージョン番号を取得します。
@return 型のメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Object Library', 'Documents')
p tobj.major_version # => 8 -
WIN32OLE
_ TYPE # name -> String (45622.0) -
selfの型名を取得します。
selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application" -
WIN32OLE
_ VARIABLE # variable _ kind -> String (45622.0) -
変数の種類(VARKIND)を取得します。
変数の種類(VARKIND)を取得します。
この変数の種類を示す文字列を返します。
@return VARKINDに対応する文字列を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.variable_kind}.uniq # => CONSTANT
返送値は以下のいずれかとなります。
: PERINSTANCE
インスタンス毎の変数。構造体やユーザ定義体のフィールド。(0)
: STATI... -
WIN32OLE
_ VARIABLE # varkind -> Integer (45622.0) -
変数の種類(VARKIND)を取得します。
変数の種類(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
_ TYPELIB # library _ name -> String (45604.0) -
TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。
TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。
@return TypeLibの名前を文字列で返します。
@raise WIN32OLERuntimeError ドキュメント文字列が取得できなかった場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib.library_name # => Excel -
WIN32OLE
_ TYPELIB # major _ version -> Integer (45604.0) -
TypeLibのメジャーバージョン番号を取得します。
TypeLibのメジャーバージョン番号を取得します。
@return TypeLibのメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.major_version # => 1 -
WIN32OLE
_ TYPELIB # name -> String (45604.0) -
TypeLibのドキュメント文字列を取得します。
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 # ole _ classes -> [WIN32OLE _ TYPE] (36928.0) -
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments... -
WIN32OLE
_ TYPELIB # ole _ types -> [WIN32OLE _ TYPE] (36928.0) -
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されているすべての型を取得します。
TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments... -
WIN32OLE
_ TYPE # variables -> [WIN32OLE _ VARIABLE] (36922.0) -
型が持つ変数を取得します。
型が持つ変数を取得します。
型がEnum(列挙型)やユーザ定義型の場合、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。
@return 型が持つ変数情報をWIN32OLE_VARIABLEの配列として返します。
変数を持たない場合は空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
vars = to... -
WIN32OLE
_ METHOD # name -> String (36622.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 # return _ type _ detail -> [String] (36622.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 # name -> String (36622.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 # optional? -> bool (36622.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
_ VARIABLE # name -> String (36622.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
_ TYPELIB # path -> String (36604.0) -
TypeLibのパス名を取得します。
TypeLibのパス名を取得します。
@return TypeLibのパス名を文字列で返します。この値はレジストリの登録値を
そのまま利用するため、Rubyのパス名形式(ディレクトリ区切りは
「/」)ではなく、Windowsのパス名形式(ディレクトリ区切りは「\」)
です。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tli... -
WIN32OLE
_ METHOD # params -> [WIN32OLE _ PARAM] (27922.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 # size _ opt _ params -> Integer | nil (27622.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 (27622.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
_ PARAM # default -> object | nil (27622.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
_ VARIABLE # value -> object | nil (27622.0) -
変数の値を取得します。
変数の値を取得します。
変数情報によってはenum値のように定数値を持つものがあります。valueメソッ
ドはこのような定数値を返します。
@return この変数が持つ定数値。値を持たない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.name}=#{variable.value... -
WIN32OLE
_ TYPELIB # version -> Float (27604.0) -
TypeLibのバージョン番号を取得します。
TypeLibのバージョン番号を取得します。
@return TypeLibのバージョン番号を整数部にメジャーバージョン番号、小数点
数部にマイナーバージョン番号を設定したFloatで返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.version # => 1.7 -
WIN32OLE
_ PARAM # input? -> bool (27322.0) -
パラメータがクライアントからサーバへ与えるものかを判定します。
パラメータがクライアントからサーバへ与えるものかを判定します。
OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。
input?メソッドはin属性またはinout属性なら真を返します。
@return メソッドの方向属性がinまたはinoutならば真を返します。
tobj = WIN32OLE... -
WIN32OLE
_ PARAM # retval? -> bool (27322.0) -
パラメータが戻り値かどうかを判定します。
パラメータが戻り値かどうかを判定します。
OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性(WIN32OLE_PARAM#output?が真)とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述する言語
が戻り値のように扱うか、それとも引数リストに並べるかはretval属性によっ
て決定されます。
retval?メソッドは、戻り値として記述する場合に真となります。
@return パラメータが戻り値として扱われる場合に真を返します。
tobj = WIN32OLE_TYPE.new('DirectX... -
WIN32OLE
_ TYPE # to _ s -> String (27322.0) -
selfの型名を取得します。
selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application" -
WIN32OLE
_ TYPELIB # to _ s -> String (27304.0) -
TypeLibのドキュメント文字列を取得します。
TypeLibのドキュメント文字列を取得します。
ドキュメント文字列は、コンテキストヘルプなどに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。
@return TypeLibのドキュメント文字列を返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library' -
WIN32OLE
_ METHOD # helpstring -> String | nil (18640.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 # to _ s -> String (18322.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 # to _ s -> 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
_ VARIABLE # to _ s -> String (18322.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
_ PARAM # output? -> bool (18022.0) -
パラメータがクライアントからの結果を受け取るためのものかを判定します。
パラメータがクライアントからの結果を受け取るためのものかを判定します。
OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。
output?メソッドはout属性またはinout属性なら真を返します。
@return メソッドの方向属性がoutまたはinoutならば真を返します。
tobj = W... -
WIN32OLE
_ VARIABLE # visible? -> bool (18022.0) -
変数の可視性を取得します。
変数の可視性を取得します。
@return publicアクセス可能であれば真を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.visible?}.uniq # => true