種類
- インスタンスメソッド (65)
- 特異メソッド (6)
- クラス (5)
- 定数 (1)
クラス
- WIN32OLE (3)
-
WIN32OLE
_ METHOD (18) -
WIN32OLE
_ PARAM (9) -
WIN32OLE
_ TYPE (22) -
WIN32OLE
_ TYPELIB (12) -
WIN32OLE
_ VARIABLE (7)
モジュール
キーワード
-
VT
_ ERROR (1) - WIN32OLERuntimeError (1)
-
WIN32OLE
_ PARAM (1) -
WIN32OLE
_ TYPE (1) -
WIN32OLE
_ TYPELIB (1) -
WIN32OLE
_ VARIABLE (1) - connect (1)
-
const
_ load (1) - default (1)
-
default
_ event _ sources (1) -
default
_ ole _ types (1) - dispid (1)
- event? (1)
-
event
_ interface (1) - guid (2)
- helpcontext (2)
- helpfile (2)
-
implemented
_ ole _ types (1) - input? (1)
- inspect (1)
- invkind (1)
-
invoke
_ kind (1) -
library
_ name (1) -
major
_ version (2) -
minor
_ version (2) - name (5)
- new (3)
-
offset
_ vtbl (1) -
ole
_ classes (2) -
ole
_ methods (1) -
ole
_ type (3) -
ole
_ type _ detail (1) -
ole
_ typelib (2) -
ole
_ types (1) - optional? (1)
- output? (1)
- params (1)
- path (1)
- progid (1)
-
return
_ type (1) -
return
_ type _ detail (1) -
return
_ vtype (1) - retval? (1)
-
size
_ opt _ params (1) -
size
_ params (1) -
source
_ ole _ types (1) -
src
_ type (1) -
to
_ s (5) - typekind (1)
- value (1)
-
variable
_ kind (1) - variables (1)
- varkind (1)
- version (1)
- visible? (4)
検索結果
先頭5件
-
WIN32OLE
_ METHOD # invkind -> Integer (45925.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 # invoke _ kind -> String (45925.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
_ TYPELIB # library _ name -> String (36646.0) -
TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。
...名前を取得します。
@return TypeLibの名前を文字列で返します。
@raise WIN32OLERuntimeError ドキュメント文字列が取得できなかった場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib.library_name # => Excel... -
WIN32OLE
_ METHOD # event _ interface -> String | nil (27625.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
_ TYPE # inspect -> String (27625.0) -
selfを説明的な文字列で表現します。
...ます。
@return "#<WIN32OLE_TYPE"とWIN32OLE_TYPE#to_sの結果を「:」で結合
し、「>」で閉じた文字列を返します。
x = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts x.inspect #=> #<WIN32OLE_TYPE:Worksheet>
@see WIN32OLE_TYPE#to_s... -
WIN32OLE
_ TYPE # minor _ version -> Integer (27625.0) -
型のマイナーバージョン番号を取得します。
...取得します。
@return 型のマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Object Library', 'Documents')
p tobj.minor_version # => 5... -
WIN32OLE
_ TYPE # typekind -> Integer (27625.0) -
selfの種類を示す値を取得します。
...。
値の意味については、WIN32OLE_TYPE#ole_typeを参照してください。
@return 型の種類を示す数値を返します。
@raise WIN32OLERuntimeError 型の種類(TYPEKIND)を取得できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Objec......t Library', 'Documents')
p tobj.typekind # => 4
@see WIN32OLE_TYPE#ole_type... -
WIN32OLE
_ TYPELIB # minor _ version -> Integer (27625.0) -
TypeLibのマイナーバージョン番号を取得します。
...取得します。
@return TypeLibのマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.minor_version # => 7... -
WIN32OLE
_ VARIABLE # varkind -> Integer (27625.0) -
変数の種類(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
_ PARAM # input? -> bool (27343.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
_ VARIABLE # variable _ kind -> String (27325.0) -
変数の種類(VARKIND)を取得します。
...得します。
この変数の種類を示す文字列を返します。
@return VARKINDに対応する文字列を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.variable_kind}.uniq # => CONSTANT
返送値は......。構造体やユーザ定義体のフィールド。(0)
: STATIC
クラスの静的変数。(1)
: CONSTANT
定数。enumやモジュールのメンバ。(2)
: DISPATCH
変数アクセスにオートメーションを利用。旧型式のプロパティ。(3)
@see WIN32OLE_VARIABLE#varkind... -
WIN32OLE
_ TYPE # ole _ typelib -> WIN32OLE _ TYPELIB | nil (18643.0) -
この型を登録してある型情報ライブラリ(TypeLib)を取得します。
...TypeLib)を取得します。
@return この型を登録しているTypeLibをWIN32OLE_TYPELIBオブジェクト
として返します。見つからない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.ole_typel... -
WIN32OLE
# ole _ typelib -> WIN32OLE _ TYPELIB (18625.0) -
オブジェクトに対応する型情報ライブラリ(TypeLib)を WIN32OLE_TYPELIBとして返します。
...オブジェクトに対応する型情報ライブラリ(TypeLib)を
WIN32OLE_TYPELIBとして返します。
OLEオートメーションではクラス、インターフェイス、メソッド、引数などの型
情報と文書情報を型情報ライブラリとして利用します。......Infoインターフェイス)で提供します。WIN32OLEは、このオブジェクト
をラップしてWIN32OLE_TYPELIBとして提供します。
@return オブジェクトに対応するWIN32OLE_TYPELIBオブジェクト。
@raise WIN32OLERuntimeError オートメーションサーバの呼......び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE.new('Excel.Application')
tlib = excel.ole_typelib
puts tlib.name # => 'Microsoft Excel 9.0 Object Library'... -
WIN32OLE
_ METHOD # helpfile -> String | nil (18625.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
_ TYPE # helpfile -> String | nil (18625.0) -
オブジェクトに関連付けられたヘルプファイルのフルパス名。
...ジェクトに関連付けられたヘルプファイルのフルパス名。
ここで返されたヘルプファイルを表示するには、
WIN32OLE#ole_show_helpメソッドを呼び出します。
オブジェクトがヘルプファイルを持たない場合はnilを返します。
@ret......未定義の場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpfile # => C:\...\VBAXL9.CHM
WIN32OLE.ole_show_help tobj.helpfile, tobj.helpcontext
# 注)WIN32OLE.ole_show_help(tobj) の呼び出しが望ましい... -
WIN32OLE
_ TYPE # variables -> [WIN32OLE _ VARIABLE] (18625.0) -
型が持つ変数を取得します。
...、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。
@return 型が持つ変数情報をWIN32OLE_VARIABLEの配列として返します。
変数を持たない場合は空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得......できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
vars = tobj.variables
vars.each do |v|
puts "#{v.name} = #{v.value}"
end
上記を実行すると以下の出力が得られます。
xlChart = -4109
x......lDialogSheet = -4116
xlExcel4IntlMacroSheet = 4
xlExcel4MacroSheet = 3
xlWorksheet = -4167
@see WIN32OLE_VARIABLE... -
WIN32OLE
_ METHOD # return _ type _ detail -> [String] (18343.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
_ PARAM # ole _ type _ detail -> [String] (18343.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
_ METHOD # dispid -> Integer (18325.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 # size _ opt _ params -> Integer | nil (18325.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 (18325.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 # visible? -> bool (18325.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 # optional? -> bool (18325.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
_ TYPE # guid -> String | nil (18325.0) -
この型のGUID(グローバル一意識別子)を取得します。
...意識別子)を取得します。
@return GUIDを文字列で返します。GUIDを持たない型の場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
puts tobj.guid # => {00024500-0000-0000-C000-000000000046}
GUIDは、COMのク... -
WIN32OLE
_ TYPE # implemented _ ole _ types -> [WIN32OLE _ TYPE] (18325.0) -
この型が実装するインターフェイスを取得します。
...ーフェイスをWIN32OLE_TYPEの
配列として返します。この型がインターフェイスを実装しない場合は、
空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。
tobj = WIN32OLE_TYPE.new('Microso... -
WIN32OLE
_ TYPE # major _ version -> Integer (18325.0) -
型のメジャーバージョン番号を取得します。
...取得します。
@return 型のメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。
tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Object Library', 'Documents')
p tobj.major_version # => 8... -
WIN32OLE
_ TYPE # progid -> String | nil (18325.0) -
selfのPROGIDを取得します。
...リ登録名です。WIN32OLE.newの引数に指定して
WIN32OLEオブジェクトを生成できます。
@return selfのPROGIDを文字列で返します。selfがPROGIDを持たない、または
CoClassでない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Exc......el 14.0 Object Library', 'Application')
p tobj.progid # => "Excel.Application.14"
この例は、ExcelのApplicationクラスが「Excel.Application.14」という
PROGIDを持つことを示します。
@see WIN32OLE.new... -
WIN32OLE
_ TYPE # visible? -> bool (18325.0) -
この型が公開されているかどうかを照会します。
...この型が公開されているかどうかを照会します。
@return 公開されていれば真を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.visible? # => true... -
WIN32OLE
_ TYPELIB # guid -> String (18325.0) -
TypeLibのGUIDを取得します。
...TypeLibのGUIDを取得します。
@return TypeLibのGUIDを文字列で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.guid # => '{00020813-0000-0000-C0... -
WIN32OLE
_ TYPELIB # major _ version -> Integer (18325.0) -
TypeLibのメジャーバージョン番号を取得します。
...取得します。
@return TypeLibのメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.major_version # => 1... -
WIN32OLE
_ TYPELIB # version -> Float (18325.0) -
TypeLibのバージョン番号を取得します。
...号、小数点
数部にマイナーバージョン番号を設定したFloatで返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.version # => 1.7... -
WIN32OLE
_ TYPELIB # visible? -> bool (18325.0) -
TypeLibの情報が公開情報かどうかを照会します。
...とみなして偽を返します。
@return TypeLibが公開可能であれば真を返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.visible? # => true... -
WIN32OLE
_ VARIABLE # visible? -> bool (18325.0) -
変数の可視性を取得します。
...変数の可視性を取得します。
@return publicアクセス可能であれば真を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.visible?}.uniq # => true... -
WIN32OLERuntimeError (18025.0)
-
COMインターフェイスエラー時に発生する例外です。
...COMインターフェイスエラー時に発生する例外です。
WIN32OLERuntimeErrorは、OLEオートメーション呼び出しが例外ステータス
(HRESULTのMSBがオン)で返った場合や、メソッド呼び出し時にオートメーショ
ン仕様で認められていな... -
WIN32OLE
_ PARAM (18025.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
_ TYPE (18025.0) -
WIN32OLE_TYPEオブジェクトは、型情報ライブラリ(TypeLib)内に定義された 1つの型情報を保持します。
...WIN32OLE_TYPEオブジェクトは、型情報ライブラリ(TypeLib)内に定義された
1つの型情報を保持します。
=== サンプルコード
require 'win32ole'
excel_app_type = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
puts excel_app_type.pro......lication.14"
Ruby-1.9.1以降、WIN32OLE_TYPELIBオブジェクトの
WIN32OLE_TYPELIB#ole_typesメソッドを利用して、型情報ライブラリ内
に定義されているすべての型情報をWIN32OLE_TYPEオブジェクトの配列として取
得できます。
@see WIN32OLE_TYPELIB... -
WIN32OLE
_ TYPELIB (18025.0) -
OLEオートメーションサーバの型情報ライブラリ(TypeLib)を操作するための クラスです。
...要求によって参照可能となりま
す。
WIN32OLE_TYPELIBクラスは、TypeLibを操作して各種情報を参照するためのオブ
ジェクトを生成します。
=== サンプルコード
require 'win32ole'
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library'......rsion = 1.7
creatable classes:
Application: PROGID=Excel.Application.14
Chart: PROGID=Excel.Chart.8
Worksheet: PROGID=Excel.Sheet.8
ここでは、Excelのクラスのうち、WIN32OLE.newで作成可能なクラスを引
数で指定する名前(PROGID)と共に示しています。... -
WIN32OLE
_ VARIABLE (18025.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... -
WIN32OLE
_ TYPELIB . new(libname , mjv = nil , miv = nil) -> WIN32OLE _ TYPELIB (9697.0) -
WIN32OLE_TYPELIBオブジェクトを生成します。
...WIN32OLE_TYPELIBオブジェクトを生成します。
@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
(WIN32OLE_TYPELIB#name)または
GUID(WIN32OLE_TYPELIB#guid)またはTLBファイル名を
文字列で......。
@return libnameで指定したWIN32OLE_TYPELIBオブジェクトを返します。
@raise WIN32OLERuntimeError 引数で指定したTypeLibが見つかりません。
tlib1 = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib2 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C0......0000000046}')
tlib3 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C000-000000000046}', 1.7)
tlib4 = WIN32OLE_TYPELIB.new('{00020813-0000-0000-C000-000000000046}', 1, 7)
tlib5 = WIN32OLE_TYPELIB.new("C:\\WINDOWS\\SYSTEM32\\SHELL32.DLL")
puts tlib1.name # => 'Microsoft Excel 14.0 Object... -
WIN32OLE
_ TYPE # src _ type -> String | nil (9361.0) -
selfが他の型の別名ならば、元の型名を取得します。
...ます。
@return selfが別名ならば元の型名を文字列で返します。別名でなければnilを
返します。
tobj = WIN32OLE_TYPE.new('Microsoft Office 14.0 Object Library', 'MsoRGBType')
p tobj.src_type # => "I4"
この例は、OfficeのMsoRGBType型は符号付... -
WIN32OLE
_ METHOD # return _ type -> String (9343.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
_ PARAM # ole _ type -> String (9343.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
_ TYPELIB # name -> String (9343.0) -
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 # to _ s -> String (9343.0) -
TypeLibのドキュメント文字列を取得します。
...どに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。
@return TypeLibのドキュメント文字列を返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.name # => 'Microsoft Excel 14.0 Object Library'... -
WIN32OLE
. connect(ole) -> WIN32OLE (9325.0) -
現在実行中のOLEオートメーションサーバに接続します。
...バを操作可能
なWIN32OLEオブジェクトが返ります。
@param ole 接続対象のサーバを示すPROGID、CLSIDまたはモニカ(別名)を指定します。
@return ole引数で特定されるWIN32OLEオブジェクトを返します。
@raise WIN32OLERuntimeError オートメ......出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
WIN32OLE.connect('Excel.Application') # => WIN32OLE object which represents running Excel.
: PROGID
OLEオートメーションサーバを識別するための文字列。... -
WIN32OLE
. const _ load(ole , mod = WIN32OLE) -> () (9325.0) -
OLEオートメーションサーバが保持する定数を読み込み、指定されたモジュール に組み込みます。
...み込む対象のWIN32OLEオブジェクトまたはタイプライブラ
リ名(文字列)を指定します。
@param mod 定数を定義する対象のモジュールを指定します。省略時は
WIN32OLEに組み込まれます。
@raise WIN32OLERuntimeError オ......規約に準じて、vbConstantsの
ように小文字で始まります。しかし、Rubyの定数は大文字で開始する規則のた
め、WIN32OLEによってVbConstantsのように自動的に先頭が大文字化されます。
また、先頭が英字で始まらない定数について......end
excel = WIN32OLE.new('Excel.Application')
WIN32OLE.const_load(excel, EXCEL_CONST)
puts EXCEL_CONST::XlTop # => -4160
puts EXCEL_CONST::CONSTANTS['_xlDialogChartSourceData'] # => 541
モジュール名を省略した例
WIN32OLE.const_load(excel)
puts WIN32OLE::XlTop # => -4... -
WIN32OLE
:: VARIANT :: VT _ ERROR -> Integer (9325.0) -
HRESULTを示します(10)。
HRESULTを示します(10)。
HRESULTは、COMを含むWindowsのサービスがアプリケーションへ通知する統一的
なエラーコードです。
HRESULT: http://msdn.microsoft.com/en-us/library/cc704587(v=PROT.10).aspx -
WIN32OLE
_ METHOD # helpcontext -> Integer | nil (9325.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 # name -> String (9325.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 (9325.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] (9325.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 _ vtype -> Integer (9325.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 # to _ s -> String (9325.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 . new(ole _ type , method) -> WIN32OLE _ METHOD (9325.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
_ PARAM # default -> object | nil (9325.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 # name -> String (9325.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 # to _ s -> String (9325.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] (9325.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 # default _ ole _ types -> [WIN32OLE _ TYPE] (9325.0) -
型が持つデフォルトのインターフェイスを取得します。
...ポートし
ていればデフォルトのソースインターフェイスを返します。
@return デフォルトインターフェイスをWIN32OLE_TYPEの配列として返し
ます。デフォルトインターフェイスは、最大でも、クラス操作用のイ
ンタ......ターフェイスの2要素です。デフォルトインターフェイスを持たない
場合は空配列を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
tobj.default_ole_types.map {|intf| intf.name} #=> ["_Worksheet", "DocEvents"]... -
WIN32OLE
_ TYPE # helpcontext -> Integer | nil (9325.0) -
この型に関連するヘルプファイルのトピックID(ヘルプコンテキスト)を取得 します。
...。
@return 型に関連するヘルプコンテキストを整数で返します。ヘルプコンテキ
ストが登録されていない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpcontext # => 131185... -
WIN32OLE
_ TYPE # name -> String (9325.0) -
selfの型名を取得します。
...selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"... -
WIN32OLE
_ TYPE # ole _ methods -> [WIN32OLE _ METHOD] (9325.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
_ TYPE # ole _ type -> String | nil (9325.0) -
selfの型の種類(TYPEKIND)を取得します。
...取得します。
@return selfの型の種類を文字列で返します。情報が取得できない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.ole_type # => Class
ole_typeには以下があります。
: Enum
列......コンポーネントクラス(InterfaceやDispatchの実装)(5)
: Alias
他の型の別名(6)
: Union
共用体(7)
: Max
型の種類を示す列挙体の終端マーカ(8)
MaxはTYPEKINDの終端マーカなので意味を持ちません。
@see WIN32OLE_TYPE#typekind... -
WIN32OLE
_ TYPE # source _ ole _ types -> [WIN32OLE _ TYPE] (9325.0) -
型が持つソースインターフェイスを取得します。
...うにイベント(WIN32OLE_EVENT)をサポートし
ているコンポーネントクラスの場合は、このメソッドの呼び出しによりイベン
トインターフェイスを調べることが可能です。
@return ソースインターフェイスをWIN32OLE_TYPEの配列とし......て返します。
ソースインターフェイスを持たない場合は空配列を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
tobj.source_ole_types.map {|intf| intf.name} #=> ["DocEvents"]... -
WIN32OLE
_ TYPE # to _ s -> String (9325.0) -
selfの型名を取得します。
...selfの型名を取得します。
@return selfの型名を文字列で返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"... -
WIN32OLE
_ TYPE . new(libname , ole _ class) -> WIN32OLE _ TYPE (9325.0) -
WIN32OLE_TYPEオブジェクトを生成します。
...WIN32OLE_TYPEオブジェクトを生成します。
@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
(WIN32OLE_TYPELIB#name)または
GUID(WIN32OLE_TYPELIB#guid)またはTLBファイル名を
文字列で指......ypeLIbに定義された型の情報を格納したWIN32OLE_TYPEオブジェクトを返します。
@raise WIN32OLERuntimeError TypeLibが見つかりません。またはole_classで指定した型が未定義です。
excel_app_type = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'A......pplication')
puts excel_app_type.progid # => "Excel.Application.14"
TypeLibに定義されているすべての型を取得するには、
WIN32OLE_TYPELIBオブジェクトのWIN32OLE_TYPELIB#ole_typesメ
ソッドを利用します。... -
WIN32OLE
_ TYPE . ole _ classes(libname) -> [WIN32OLE _ TYPE] (9325.0) -
TypeLibで定義されているすべての型情報を取得します。
...(WIN32OLE_TYPELIB#name)または
GUID(WIN32OLE_TYPELIB#guid)またはTLBファイル名を
文字列で指定します。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェクトの配列として返します。
@raise WIN32OLERun......types = WIN32OLE_TYPE.ole_classes('Microsoft Excel 14.0 Object Library')
classes = types.map{|k| k.name} # => ["Adjustments", "CalloutFormat", ...]
Ruby-1.9.1からは、TypeLibに定義されているすべての型を取得するには、
WIN32OLE_TYPELIBオブジェクトのWIN32OLE_TYPELIB... -
WIN32OLE
_ TYPELIB # ole _ classes -> [WIN32OLE _ TYPE] (9325.0) -
TypeLibに格納されているすべての型を取得します。
...挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["... -
WIN32OLE
_ TYPELIB # ole _ types -> [WIN32OLE _ TYPE] (9325.0) -
TypeLibに格納されているすべての型を取得します。
...挙子)、構造体などがあります。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["... -
WIN32OLE
_ TYPELIB # path -> String (9325.0) -
TypeLibのパス名を取得します。
...、Windowsのパス名形式(ディレクトリ区切りは「\」)
です。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.path # => 'C:\...\EXCEL.EXE'
Typ... -
WIN32OLE
_ VARIABLE # name -> String (9325.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
_ VARIABLE # ole _ type -> String (9325.0) -
変数の型を取得します。
...返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variable.ole_type} #{variable.name}"
end
OLEオートメーションの型名は、対応するWIN32OLE::VARIANTの定数の先... -
WIN32OLE
_ VARIABLE # to _ s -> String (9325.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
_ VARIABLE # value -> object | nil (9325.0) -
変数の値を取得します。
...このような定数値を返します。
@return この変数が持つ定数値。値を持たない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variabl... -
WIN32OLE
_ PARAM # retval? -> bool (9043.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
_ METHOD # event? -> bool (9025.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
_ PARAM # output? -> bool (9025.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?}...