種類
- インスタンスメソッド (101)
- 定数 (38)
- 特異メソッド (23)
- クラス (9)
- モジュール (1)
クラス
- WIN32OLE (45)
-
WIN32OLE
_ EVENT (8) -
WIN32OLE
_ METHOD (19) -
WIN32OLE
_ PARAM (10) -
WIN32OLE
_ TYPE (25) -
WIN32OLE
_ TYPELIB (13) -
WIN32OLE
_ VARIABLE (8) -
WIN32OLE
_ VARIANT (10)
モジュール
-
WIN32OLE
:: VARIANT (24)
キーワード
- ARGV (1)
-
CP
_ ACP (1) -
CP
_ MACCP (1) -
CP
_ OEMCP (1) -
CP
_ SYMBOL (1) -
CP
_ THREAD _ ACP (1) -
CP
_ UTF7 (1) -
CP
_ UTF8 (1) - Empty (1)
-
LOCALE
_ SYSTEM _ DEFAULT (1) -
LOCALE
_ USER _ DEFAULT (1) - Nothing (1)
- Null (1)
- VARIANT (1)
- VERSION (1)
-
VT
_ ARRAY (1) -
VT
_ BOOL (1) -
VT
_ BSTR (1) -
VT
_ BYREF (1) -
VT
_ CY (1) -
VT
_ DATE (1) -
VT
_ DISPATCH (1) -
VT
_ EMPTY (1) -
VT
_ ERROR (1) -
VT
_ I1 (1) -
VT
_ I2 (1) -
VT
_ I4 (1) -
VT
_ INT (1) -
VT
_ NULL (1) -
VT
_ PTR (1) -
VT
_ R4 (1) -
VT
_ R8 (1) -
VT
_ UI1 (1) -
VT
_ UI2 (1) -
VT
_ UI4 (1) -
VT
_ UINT (1) -
VT
_ UNKNOWN (1) -
VT
_ USERDEFINED (1) -
VT
_ VARIANT (1) - WIN32OLE (1)
- WIN32OLERuntimeError (1)
-
WIN32OLE
_ EVENT (1) -
WIN32OLE
_ METHOD (1) -
WIN32OLE
_ PARAM (1) -
WIN32OLE
_ TYPE (1) -
WIN32OLE
_ TYPELIB (1) -
WIN32OLE
_ VARIABLE (1) -
WIN32OLE
_ VARIANT (1) - [] (2)
- []= (2)
-
_ getproperty (1) -
_ invoke (1) -
_ setproperty (1) - array (1)
- codepage (1)
- codepage= (1)
- connect (1)
-
const
_ load (1) -
create
_ guid (1) - default (1)
-
default
_ event _ sources (1) -
default
_ ole _ types (1) - dispid (1)
- each (1)
- event? (1)
-
event
_ interface (1) - guid (2)
- handler (1)
- handler= (1)
- helpcontext (2)
- helpfile (2)
- helpstring (2)
-
implemented
_ ole _ types (1) - input? (1)
- inspect (1)
- invkind (1)
- invoke (1)
-
invoke
_ kind (1) -
library
_ name (1) - locale (1)
- locale= (1)
-
major
_ version (2) -
method
_ missing (1) -
minor
_ version (2) - name (5)
- new (7)
-
off
_ event (1) -
offset
_ vtbl (1) -
ole
_ activex _ initialize (1) -
ole
_ classes (2) -
ole
_ free (2) -
ole
_ func _ methods (1) -
ole
_ get _ methods (1) -
ole
_ method (1) -
ole
_ method _ help (1) -
ole
_ methods (2) -
ole
_ obj _ help (1) -
ole
_ put _ methods (1) -
ole
_ query _ interface (1) -
ole
_ reference _ count (1) -
ole
_ respond _ to? (1) -
ole
_ show _ help (1) -
ole
_ type (4) -
ole
_ type _ detail (2) -
ole
_ typelib (2) -
ole
_ types (1) -
on
_ event (1) -
on
_ event _ with _ outargs (1) - optional? (1)
- output? (1)
- params (1)
- path (1)
- progid (1)
- progids (1)
-
return
_ type (1) -
return
_ type _ detail (1) -
return
_ vtype (1) - retval? (1)
- setproperty (2)
-
size
_ opt _ params (1) -
size
_ params (1) -
source
_ ole _ types (1) -
src
_ type (1) -
to
_ s (5) - typekind (1)
- typelibs (2)
- unadvise (1)
- value (2)
- value= (1)
-
variable
_ kind (1) - variables (1)
- varkind (1)
- vartype (1)
- version (1)
- visible? (4)
検索結果
先頭5件
-
WIN32OLE (7.0)
-
OLEオートメーションサーバをRubyで操作するためのクラスです。
...多くのアプリケーションやライブラリは、COMと呼ばれるAPI群を利用
して他のプログラムから操作できます。WIN32OLEがサポートしているのは、
COMのAPIのうち、特にインタープリタ用のインターフェイスであるOLEオートメー
シ......てWindowsの情報を操作することも可能です。これらの
プログラムをOLEオートメーションサーバと呼びます。
WIN32OLEオブジェクトは、OLEオートメーションサーバが提供するメソッドやプ
ロパティ(Rubyの属性に対応)をスクリ......、名前付き引数としてキーにパラメータ名、値に引数を指定できます。
=== サンプルコード
require 'win32ole'
excel = WIN32OLE.new('Excel.Application')
workbook = excel.Workbooks.Open('workbook.xls')
workbook.PrintOut
workbook.Close(:SaveChanges => false)... -
WIN32OLE
# [](key . . . ) -> object (7.0) -
オブジェクトのデフォルトプロパティを参照します。
...ションにはデフォルトプロパティというプロパティ名を指定せず
にアクセスできるプロパティがあります。
WIN32OLEからデフォルトプロパティにアクセスするには、[]内に必要なキーを
「,」で区切って記述します。シンボル......を指定します。プロ
パティの特定に複数のキーが必要な場合は「,」で区切って列記します。
@return プロパティ値を返します。
fsys = WIN32OLE.new('Scripting.FileSystemObject')
fsys.Drives[:c].FreeSpace #=> Cドライブの空き容量... -
WIN32OLE
# []=(key . . . , value) -> () (7.0) -
オブジェクトのデフォルトプロパティを設定します。
...ションにはデフォルトプロパティというプロパティ名を指定せず
にアクセスできるプロパティがあります。
WIN32OLEからデフォルトプロパティにアクセスするには、[]内に必要なキーを
記述します。
なおデフォルトプロパ......に設定する値を指定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
dict = WIN32OLE.new('Scripting.Dictionary')
dict[:a] = 0x41
d... -
WIN32OLE
# _ getproperty(dispid , args , types) -> object (7.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
# _ invoke(dispid , args , types) -> object | nil (7.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
# _ setproperty(dispid , args , types) -> () (7.0) -
DISPIDとパラメータの型を指定してオブジェクトのプロパティを設定します。
...
WIN32OLE::VARIANTの定数を利用します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
DISPID_CELLS = 238
include WIN32OLE::VA......RIANT
excel = WIN32OLE.new('Excel.Application')
puts excel._setproperty(558, # VisibleプロパティのDISPIDは558
[true], [VT_BOOL])
workbook = excel.Workbooks.Add
sheet = workbook.Worksheets[1]
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
# each {|i| . . . } -> () (7.0) -
オブジェクトの列挙インターフェイスを呼び出してアイテム単位にブロックを 実行します。
...います。
@param i コレクション内のアイテム
@raise WIN32OLERuntimeError selfが列挙インターフェイスをサポートしてい
ない場合に通知します。
excel = WIN32OLE.new('Excel.Application')
book = excel.workbooks.add
sheets =... -
WIN32OLE
# invoke(name , *args) -> object | nil (7.0) -
メソッド名を指定してオブジェクトのメソッドを呼び出します。
...持たないメソッドの場合はnil。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
excel = WIN32OLE.new('Excel.Application')
workbook = excel.wor......:Password => 'secret')
excel.invoke(:Quit)
このリストは、以下の記述と同等です。
excel = WIN32OLE.new('Excel.Application')
workbook = excel.workbooks.Open(:FileName => 'c:\\users\\public\\test.xml',
:ReadOn... -
WIN32OLE
# method _ missing(id , *args) -> object | nil (7.0) -
WIN32OLE#invokeメソッドを実行します。
...WIN32OLE#invokeメソッドを実行します。
WIN32OLEのインスタンスに対して、このリファレンスに明記されていないメソッ
ドを呼び出した場合、OLEオートメーションサーバのメソッド(プロパティ)呼
び出しと解釈します。
@param......有効なシンボルではありません。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
WIN32OLEはOLEオートメーションオブジェクトのメ......ソッド呼び出しを
method_missingを利用して実行します。このためWIN32OLEを継承するクラスを
作成してmethod_missingをオーバーライドする場合、superを呼び出してくださ
い。
@see WIN32OLE#invoke... -
WIN32OLE
# ole _ activex _ initialize -> nil (7.0) -
ActiveXコントロール用の初期化を行います。
...出しがすべてエラーとなります。
@raise WIN32OLERuntimeError オブジェクトがActiveXコントロールの永続化イ
ンターフェイスを持たない場合に通知します。
obj = WIN32OLE.new("ProgID_or_GUID_of_ActiveX_Control")
obj.ole_......でないかを簡単に区別する方法はありません。
そのため、とりあえず普通にメソッドを呼び出し、その結果
WIN32OLERuntimeErrorが通知され、メッセージにHRESULT 0x8000ffffと示され
ている場合にのみ、オブジェクト生成直後に当メ... -
WIN32OLE
# ole _ free -> () (7.0) -
selfが参照するCOMオブジェクトを解放します。
...に対
する操作は行えません。
excel = WIN32OLE.new('Excel.Application')
excel.ole_free # オブジェクトの解放
excel.Quit #=> RuntimeError (failed to get Dispatch Interface)
通常は利用されなくなったWIN32OLEオブジェクトはGCのタイミングで自動......中で生成される子オブジェクトからの逆参照などがあるため、
WIN32OLEがIUnknown::Releaseを呼び出してもオブジェクトが解放されるとは限
りません。
excel = WIN32OLE.new('Excel.Application')
workbook = excel.Workbooks.Open('workbook.xls')
workbo......参照されているexcelオブジェクトは解
放されません。それに対して下の例では正しく解放されます。
excel = WIN32OLE.new('Excel.Application')
books = excel.Workbooks
workbook = books.Open('workbook.xls')
books.ole_free
workbook.Close(:SaveChanges => fal... -
WIN32OLE
# ole _ func _ methods -> [WIN32OLE _ METHOD] (7.0) -
オブジェクトのファンクション情報をWIN32OLE_METHODの配列として返し ます。
...をWIN32OLE_METHODの配列として返し
ます。
ole_func_methodsメソッドは、OLEオートメーションサーバのメソッドのうちファ
ンクション(何らかの機能的な操作)に属するものをWIN32OLE_METHODの
配列として返します。
@return WIN32OLE_METHO......Dの配列。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE.new('Excel.Application')
excel.visible......= true
excel.ole_func_methods.each do |fun|
if fun.name.upcase == 'QUIT'
excel._invoke(fun.dispid, [], [])
break
end
end
@see WIN32OLE#ole_methods, WIN32OLE#ole_get_methods,
WIN32OLE#ole_put_methods... -
WIN32OLE
# ole _ get _ methods -> [WIN32OLE _ METHOD] (7.0) -
オブジェクトの参照可能プロパティ情報をWIN32OLE_METHODの配列として 返します。
...報をWIN32OLE_METHODの配列として
返します。
ole_get_methodsメソッドは、OLEオートメーションサーバのメソッドのうち読
み取り可能なプロパティをWIN32OLE_METHODの配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeEr......xcel = WIN32OLE.new('Excel.Application')
excel.ole_get_methods.each do |prop|
begin
puts "#{prop.name}=#{excel._getproperty(prop.dispid, [], [])}"
rescue WIN32OLERuntimeError
puts "can't read #{prop.name} property"
end
end
@see WIN32OLE#ole_methods, WIN32OLE#ole_f......unc_methods,
WIN32OLE#ole_put_methods... -
WIN32OLE
# ole _ method(method) -> WIN32OLE _ METHOD (7.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
...るWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_M......オブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発生します。
excel = WIN32OLE.new('Excel.Application')... -
WIN32OLE
# ole _ method _ help(method) -> WIN32OLE _ METHOD (7.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
...るWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_M......オブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発生します。
excel = WIN32OLE.new('Excel.Application')... -
WIN32OLE
# ole _ methods -> [WIN32OLE _ METHOD] (7.0) -
オブジェクトのメソッド情報をWIN32OLE_METHODの配列として返します。
...メソッド情報をWIN32OLE_METHODの配列として返します。
ole_methodsメソッドは、OLEオートメーションサーバが提供するすべてのメソッ
ドをWIN32OLE_METHODの配列として返します。
@return WIN32OLE_METHODの配列。
@raise WIN32OLERuntimeError オー......の呼び出しに失敗しました。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE.new('Excel.Application')
methods = excel.ole_methods
@see WIN32OLE#ole_func_methods, WIN32OLE#ole_put_methods... -
WIN32OLE
# ole _ obj _ help -> WIN32OLE _ TYPE | nil (7.0) -
WIN32OLE_TYPEオブジェクトを返します。
...WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。
@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェク......トがドキュメント情報を持たない場合はnilを返します。
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
@see WIN32OLE_TYPE... -
WIN32OLE
# ole _ put _ methods -> [WIN32OLE _ METHOD] (7.0) -
オブジェクトの設定可能プロパティ情報をWIN32OLE_METHODの配列として 返します。
...ティ情報をWIN32OLE_METHODの配列として
返します。
ole_put_methodsメソッドは、OLEオートメーションサーバのメソッドのうちプ
ロパティ設定メソッドに属するものをWIN32OLE_METHODの配列として返し
ます。
@return WIN32OLE_METHODの配列。......た。
型情報ライブラリ(TypeLib)が提供されていない場合などに発生します。
excel = WIN32OLE.new('Excel.Application')
properties = excel.ole_put_methods
@see WIN32OLE#ole_methods, WIN32OLE#ole_func_methods,
WIN32OLE#ole_get_methods... -
WIN32OLE
# ole _ query _ interface(iid) -> WIN32OLE (7.0) -
IID(インターフェイスID)を指定してオブジェクトの別のインターフェイスを 持つオブジェクトを取得します。
...return iidパラメータで指定したインターフェイスを持つWIN32OLEオブジェクト
@raise WIN32OLERuntimeError 指定したIIDをオブジェクトが持たない場合に通知されます。
ie = WIN32OLE.new('InternetExplorer.Application')
ie_web_app = ie.ole_query_inter......たOLEオートメーションサーバでは本メソッドが意味
を持つことはありません。というのは、2つ以上の異なるWIN32OLEで操作可能な
インターフェイスを持つということは、IID_IDispatch(OLEオートメーション
のインターフェイスID......っているため、静的に型を解決して
いる場合は、追加のメソッドの呼び出しを記述できません。
しかし、WIN32OLEが利用するIDispatchインターフェイスは、メソッド名による
動的なメソッド検索が行われます。このため、Soluti... -
WIN32OLE
# ole _ respond _ to?(name) -> bool (7.0) -
指定したメソッドをオブジェクトがサポートしているか調べます。
...ド名を文字列またはシンボルで指定します。
@return nameで指定したメソッドをオブジェクトが提供していれば真を返します。
excel = WIN32OLE.new('Excel.Application')
excel.ole_respond_to?(:quit) #=> true
excel.ole_respond_to?(:exit) #=> false... -
WIN32OLE
# ole _ type -> WIN32OLE _ TYPE | nil (7.0) -
WIN32OLE_TYPEオブジェクトを返します。
...WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。
@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェク......トがドキュメント情報を持たない場合はnilを返します。
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
@see WIN32OLE_TYPE... -
WIN32OLE
# ole _ typelib -> WIN32OLE _ TYPELIB (7.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
# setproperty(name , args . . . , val) -> () (7.0) -
オブジェクトのプロパティを設定します。
...ます。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESUL......のため、次の例のようにsetpropertyメソッドを利用して、パラメータ付きプ
ロパティを設定します。
excel = WIN32OLE.new('Excel.Application')
excel.visible = true
sheet = excel.Workbooks.Add.Worksheets[1]
sheet.setproperty(:Cells, 1, 2, 32)
sheet.set... -
WIN32OLE
# setproperty(name , val) -> () (7.0) -
オブジェクトのプロパティを設定します。
...ます。
@param args 集合的なプロパティに対する設定項目を特定するための引数を指
定します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESUL......のため、次の例のようにsetpropertyメソッドを利用して、パラメータ付きプ
ロパティを設定します。
excel = WIN32OLE.new('Excel.Application')
excel.visible = true
sheet = excel.Workbooks.Add.Worksheets[1]
sheet.setproperty(:Cells, 1, 2, 32)
sheet.set... -
WIN32OLE
. codepage -> Integer (7.0) -
WIN32OLEがOLEオートメーションのインターフェイスに利用するコードページを 取得します。
...
WIN32OLEがOLEオートメーションのインターフェイスに利用するコードページを
取得します。
OLEオートメーションに利用する文字列はUnicodeでエンコードします。
WIN32OLEはここで示されたコードページを利用してRubyのStringとUnic......するコード
ページが見つからない場合は、WIN32OLE::CP_ACPを利用します。
@return WIN32OLEがオートメーション呼び出しの文字列変換に利用するコード
ページを返します。
WIN32OLE.codepage # => 932 (日本語Windowsの既定値)... -
WIN32OLE
. codepage=(cp) -> nil (7.0) -
WIN32OLEがOLEオートメーションのインターフェイスに利用するコードページを 設定します。
...
WIN32OLEがOLEオートメーションのインターフェイスに利用するコードページを
設定します。
WIN32OLEは、OLEオートメーション呼び出しに利用する文字列のUnicode変換に
ここで設定したコードページを利用します。通常、WIN32OLEは......出す必
要があるのは、WIN32OLEをrequireしたスクリプトと異なるエンコーディングを
利用しているスクリプトや、異なるエンコーディングを利用しているファイル
から読み込んだ文字列を利用してWIN32OLEを呼び出す場合です。......@param cp コードページを指定します。
WIN32OLE.codepage = WIN32OLE::CP_UTF8... -
WIN32OLE
. connect(ole) -> WIN32OLE (7.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) -> () (7.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
. create _ guid -> String (7.0) -
GUID(グローバル一意識別子:Global Unique Identifier)を生成します。
...ンターフェイス識別子(IID)など多数の
領域でWindows上のオブジェクトの識別に利用される128ビットの値です。
WIN32OLEが生成するGUIDは以下の形式によるGUIDの文字列表現です。なお00〜
FFはGUIDの先頭からのバイト位置を示しま......す。これはレジストリのキーとして
利用される形式です。
{33221100-5544-7766-8899-AABBCCDDEEFF}
@return GUIDの文字列表現を返します。
WIN32OLE.create_guid # => "{????????-????-????-????-????????????}"... -
WIN32OLE
. locale -> Integer (7.0) -
WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を取 得します。
...
WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を取
得します。
OLEオートメーションでは、UNIXで利用される"ja_JP"などの国名と言語名を「_」
で接続した文字列ではなく、32ビット整数で示します。32ビ......イマリ言語ID、10〜15ビットでサブ言語IDを示します。
ロード時の既定値はWIN32OLE::LOCALE_SYSTEM_DEFAULTです。
@return WIN32OLEがオートメーション呼び出し時に設定するロケール識別子
(LCID)を返します。
lcid = WIN32OLE.locale... -
WIN32OLE
. locale=(lcid) -> nil (7.0) -
WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を設 定します。
...
WIN32OLEがオートメーション呼び出し時に設定するロケール識別子(LCID)を設
定します。
OLEオートメーションでは、UNIXで利用される"ja_JP"などの国名と言語名を「_」
で接続した文字列ではなく、32ビット整数で示します。32ビ......定します。
@raise WIN32OLERuntimeError システムにインストールされていないロケール
を指定すると発生します。
WIN32OLE.locale = 1033 # set locale English(U.S)
obj = WIN32OLE_VARIANT.new("$100,000", WIN32OLE::VARIANT::VT_CY)
オ......ソッド呼び出し時にDISP_E_UNKNOWNLCID(HRESULT error code:0x8002000C)や、TYPE_E_INVDATAREAD(HRESULT error code:0x80028018)などを理由としたWIN32OLERuntimeError例外となります。ほとんどすべての場合において、既定値を変更する必要はありません。... -
WIN32OLE
. new(server , host=nil) -> WIN32OLE (7.0) -
OLEオートメーションサーバを生成します。
...ションサーバを生成し
ます。生成に成功した場合、該当サーバを操作可能なWIN32OLEオブジェクトが
返ります。
CLSIDおよびPROGIDについてはWIN32OLE.connectを参照してください。
@param server OLEオートメーションサーバを示すPROGID......引数で指定したWIN32OLEオブジェク
トを返します。
@raise WIN32OLERuntimeError オートメーションサーバの呼び出しに失敗しました。
理由はメッセージのHRESULTを調べてください。
WIN32OLE.new('Excel.Applicat......ion') # => Excel OLE Automation WIN32OLE object.
WIN32OLE.new('{00024500-0000-0000-C000-000000000046}') # => Excel OLE Automation WIN32OLE object.... -
WIN32OLE
. ole _ free(aWIN32OLE) -> Integer (7.0) -
引数で指定したオブジェクトを解放します。
...解放します。
このメソッドは主にWIN32OLEのデバッグおよびWIN32OLEを利用するミドルウェ
アの実装のために用意されています。このため、メソッドの内部動作は不定で
す。COMの仕様とWIN32OLEの内部処理に熟知していない場合......は使用しないでくだ
さい。
@param aWIN32OLE 解放するWIN32OLEオブジェクト。
@return Releaseの戻り値。COMの仕様上は現在のオブジェクトの参照カウント
値を示します。... -
WIN32OLE
. ole _ reference _ count(aWIN32OLE) -> Integer (7.0) -
引数で指定したオブジェクトの現在の参照カウント値を返します。
...を返します。
このメソッドは主にWIN32OLEのデバッグおよびWIN32OLEを利用するミドルウェ
アの実装のために用意されています。このため、メソッドの内部動作は不定で
す。COMの仕様とWIN32OLEの内部処理に熟知していない場合......は使用しないでくだ
さい。
@param aWIN32OLE 参照カウント値を求めるWIN32OLEオブジェクト。
@return AddRef呼び出し後のReleaseの戻り値。COMの仕様上は現在のオブジェ
クトの参照カウント値を示します。... -
WIN32OLE
. ole _ show _ help(obj , helpcontext = nil) -> () (7.0) -
WIN32OLEオブジェクトのヘルプファイルを表示します。
...
WIN32OLEオブジェクトのヘルプファイルを表示します。
Windows標準のヘルプ表示コンポーネントのHHCtrl.OCXを利用して、オブジェク
トに関連付けられたヘルプファイル(chmファイル)を表示します。
また、chmファイルのフル......aram obj WIN32OLE_TYPEオブジェクトまたはWIN32OLE_METHODオ
ブジェクト。直接ヘルプファイルのフルパス名を指定することも可
能です。
@param helpcontext obj引数にWIN32OLE_TYPEオブジェクトまたは
WIN32OLE_METHOD......ファイル
がインストールされていない場合 (failed to open
help file `ファイル名') に通知します。
excel = WIN32OLE.new('Excel.Application')
typeobj = excel.ole_obj_help
WIN32OLE.ole_show_help(typeobj) if typeobj.helpfile... -
WIN32OLE
:: ARGV -> [object] (7.0) -
直前のメソッド呼び出しの引数を格納した配列です。
...p x # => 10 …… 呼び出しによって影響を受けない
p WIN32OLE::ARGV # => ['*', 110, 11] …… 結果はARGVの対応する引数に反映される
obj.Accm '+', 10, 11
p WIN32OLE::ARGV # => ['+', 21, 11]
直前のメソッド呼び出しが例外となった......場合、ARGVの設定内容は呼び出し前の
状態が保たれます。つまり、WIN32OLE自身がARGVの内容を消去するのは、メソッ
ド呼び出しに成功した場合のみです。このため最後のメソッド呼び出しが引数
にオブジェクトを返すタイプ......VB (OLE Automation server)
Public Sub GetInterface(ByRef obj)
Set Obj = New OleObject
End Sub
# Ruby
obj.GetInterface nil # 引数の数を合わせるためダミー引数を指定
WIN32OLE::ARGV.clear # 通常は、後続のメソッド呼び出しによって消去される... -
WIN32OLE
:: CP _ ACP -> Integer (7.0) -
Windows既定のANSIコードページ(0)を示します。
Windows既定のANSIコードページ(0)を示します。 -
WIN32OLE
:: CP _ MACCP -> Integer (7.0) -
Macintoshコードページ(2)を示します。
Macintoshコードページ(2)を示します。 -
WIN32OLE
:: CP _ OEMCP -> Integer (7.0) -
OEMコードページ(1)を示します。
OEMコードページ(1)を示します。 -
WIN32OLE
:: CP _ SYMBOL -> Integer (7.0) -
文字コードの変換にシンボルを利用することを示します(42)。
文字コードの変換にシンボルを利用することを示します(42)。 -
WIN32OLE
:: CP _ THREAD _ ACP -> Integer (7.0) -
現在実行中のスレッドの既定のコードページ(3)を示します。
現在実行中のスレッドの既定のコードページ(3)を示します。
Windowsのコードページはスレッド毎に異なる値を設定できます。 -
WIN32OLE
:: CP _ UTF7 -> Integer (7.0) -
文字コードの変換にUTF-7を利用することを示します(65000)。
文字コードの変換にUTF-7を利用することを示します(65000)。 -
WIN32OLE
:: CP _ UTF8 -> Integer (7.0) -
文字コードの変換にUTF-8を利用することを示します(65001)。
文字コードの変換にUTF-8を利用することを示します(65001)。 -
WIN32OLE
:: LOCALE _ SYSTEM _ DEFAULT -> Integer (7.0) -
システム既定のロケールを示すLCID(0x0800)です。WIN32OLEがオートメーショ ンを利用する場合の既定値です。
...システム既定のロケールを示すLCID(0x0800)です。WIN32OLEがオートメーショ
ンを利用する場合の既定値です。... -
WIN32OLE
:: LOCALE _ USER _ DEFAULT -> Integer (7.0) -
ユーザ既定のロケールを示すLCID(0x0400)です。
ユーザ既定のロケールを示すLCID(0x0400)です。 -
WIN32OLE
:: VARIANT (7.0) -
OLEオートメーション型を指定するための定数を定義したモジュールです。
...OLEオートメーション型を指定するための定数を定義したモジュールです。
WIN32OLE::VARIANTは、WIN32OLE_VARIANTオブジェクトの作成時や、
WIN32OLE#_invokeなどのメソッド呼び出し時に、ユーザがRubyのオブジェ
クトの変換方法を指定す... -
WIN32OLE
:: VARIANT :: VT _ ARRAY -> Integer (7.0) -
配列(SafeArray)を示します(0x2000)。
配列(SafeArray)を示します(0x2000)。 -
WIN32OLE
:: VARIANT :: VT _ BOOL -> Integer (7.0) -
真偽値を示します(11)。
真偽値を示します(11)。 -
WIN32OLE
:: VARIANT :: VT _ BSTR -> Integer (7.0) -
文字列(BSTR)を示します(8)。
...文字列(BSTR)を示します(8)。
OLEオートメーションのBSTRはUnicodeで表現された長さ付き文字列です。Ruby
のStringとBSTRの相互変換は、WIN32OLEがWIN32OLE#codepageに基づいて
自動的に行います。... -
WIN32OLE
:: VARIANT :: VT _ BYREF -> Integer (7.0) -
参照を示します(0x4000)。
参照を示します(0x4000)。
VT_BYREFは型ではなく、参照を示す型属性です。OLEオートメーションサーバが
結果を引数に戻す場合、参照先の型を示す値と論理和を取るために利用します。 -
WIN32OLE
:: VARIANT :: VT _ CY -> Integer (7.0) -
通貨型(CURRENCY)を示します(6)。
...とで、加減算について誤差を生じさせない小数点
数を表現します。
CURRENCY型の有効範囲は-922337203685477.5808から922337203685477.5807です。
WIN32OLEはオートメーション呼び出しの返り値がCURRENCY型の場合、文字列に
変換します。... -
WIN32OLE
:: VARIANT :: VT _ DATE -> Integer (7.0) -
日付型(DATE)を示します(7)。
...日付型(DATE)を示します(7)。
OLEオートメーションのDATE型は、1899年12月30日0時00分からの日時を示す64
ビット浮動小数点数型です。
WIN32OLEは、RubyのTime型と自動的に変換します。... -
WIN32OLE
:: VARIANT :: VT _ DISPATCH -> Integer (7.0) -
OLEオートメーションオブジェクトを示します(9)。
OLEオートメーションオブジェクトを示します(9)。
RubyのオブジェクトをOLEオートメーションサーバへ与える場合に利用します。 -
WIN32OLE
:: VARIANT :: VT _ EMPTY -> Integer (7.0) -
空(初期化状態)のオブジェクトを示します(0)。
空(初期化状態)のオブジェクトを示します(0)。 -
WIN32OLE
:: VARIANT :: VT _ ERROR -> Integer (7.0) -
HRESULTを示します(10)。
HRESULTを示します(10)。
HRESULTは、COMを含むWindowsのサービスがアプリケーションへ通知する統一的
なエラーコードです。
HRESULT: http://msdn.microsoft.com/en-us/library/cc704587(v=PROT.10).aspx -
WIN32OLE
:: VARIANT :: VT _ I1 -> Integer (7.0) -
符号付き8ビット整数(char)を示します(16)。
符号付き8ビット整数(char)を示します(16)。
OLEオートメーションの仕様上は利用できません。 -
WIN32OLE
:: VARIANT :: VT _ I2 -> Integer (7.0) -
符号付き16ビット整数(short)を示します(2)。
符号付き16ビット整数(short)を示します(2)。 -
WIN32OLE
:: VARIANT :: VT _ I4 -> Integer (7.0) -
符号付き32ビット整数(int)を示します(3)。
符号付き32ビット整数(int)を示します(3)。 -
WIN32OLE
:: VARIANT :: VT _ INT -> Integer (7.0) -
符号付き整数(int)を示します(22)。
符号付き整数(int)を示します(22)。 -
WIN32OLE
:: VARIANT :: VT _ NULL -> Integer (7.0) -
NULL型の値を示します(1)。
...NULL型の値を示します(1)。
WIN32OLE::VARIANT.VT_EMPTYと異なり、NULLという値(たとえばSQLパラ
メータでNULLを指定する場合など)を示します。... -
WIN32OLE
:: VARIANT :: VT _ PTR -> Integer (7.0) -
ポインタ型を示します(26)。
ポインタ型を示します(26)。
VT_PTRは、VOID*に相当するため、OLEオートメーションでは利用できません。 -
WIN32OLE
:: VARIANT :: VT _ R4 -> Integer (7.0) -
単精度浮動小数点数を示します(4)。
単精度浮動小数点数を示します(4)。 -
WIN32OLE
:: VARIANT :: VT _ R8 -> Integer (7.0) -
倍精度浮動小数点数を示します(5)。
倍精度浮動小数点数を示します(5)。 -
WIN32OLE
:: VARIANT :: VT _ UI1 -> Integer (7.0) -
符号なし8ビット整数(unsigned char)を示します(17)。
符号なし8ビット整数(unsigned char)を示します(17)。 -
WIN32OLE
:: VARIANT :: VT _ UI2 -> Integer (7.0) -
符号なし16ビット整数(unsigned short)を示します(18)。
符号なし16ビット整数(unsigned short)を示します(18)。
OLEオートメーションでは利用できません。代わりにVT_I2を利用してください。 -
WIN32OLE
:: VARIANT :: VT _ UI4 -> Integer (7.0) -
符号なし32ビット整数(unsigned int)を示します(19)。
符号なし32ビット整数(unsigned int)を示します(19)。
OLEオートメーションでは利用できません。代わりにVT_I4を利用してください。 -
WIN32OLE
:: VARIANT :: VT _ UINT -> Integer (7.0) -
符号なし整数(unsigned int)を示します(23)。
符号なし整数(unsigned int)を示します(23)。
OLEオートメーションでは利用できません。代わりにVT_I4を利用してください。 -
WIN32OLE
:: VARIANT :: VT _ UNKNOWN -> Integer (7.0) -
COMインターフェイスを示します(13)。
COMインターフェイスを示します(13)。 -
WIN32OLE
:: VARIANT :: VT _ USERDEFINED -> Integer (7.0) -
ユーザ定義型を示します(29)。
ユーザ定義型を示します(29)。
OLEオートメーションでは利用できません。代わりにVT_I4を利用してください。 -
WIN32OLE
:: VARIANT :: VT _ VARIANT -> Integer (7.0) -
VARIANT型を示します(12)。
VARIANT型を示します(12)。 -
WIN32OLE
:: VERSION -> String (7.0) -
Major.Minor.Patch形式のWIN32OLEのバージョン番号を示す文字列です。
...Major.Minor.Patch形式のWIN32OLEのバージョン番号を示す文字列です。... -
WIN32OLERuntimeError (7.0)
-
COMインターフェイスエラー時に発生する例外です。
...COMインターフェイスエラー時に発生する例外です。
WIN32OLERuntimeErrorは、OLEオートメーション呼び出しが例外ステータス
(HRESULTのMSBがオン)で返った場合や、メソッド呼び出し時にオートメーショ
ン仕様で認められていな... -
WIN32OLE
_ EVENT (7.0) -
OLEオートメーションサーバからのイベント通知を制御するクラスです。
...ベント」と呼びます。WIN32OLE_EVENTを利用
すると、ブロックの形式でイベントを受け取るメソッドをサーバへ登録できま
す。
=== サンプルコード
ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents......nt.getElementsByTagName('a').each do |e|
puts "#{e.innerHTML}=#{e.href}" #=> ダウンロード=http://www.ruby-lang.org/ja/downloads/ など
end
disp.quit
b = true
end
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if b
WIN32OLE_EVENT.message_loop
end... -
WIN32OLE
_ EVENT # handler -> object (7.0) -
WIN32OLE_EVENT#handler=メソッドで登録したイベントハンドラオブジェ クトを返します。
...WIN32OLE_EVENT#handler=メソッドで登録したイベントハンドラオブジェ
クトを返します。
@return イベントハンドラオブジェクト。未登録ならばnil。... -
WIN32OLE
_ EVENT # handler=(obj) -> () (7.0) -
イベント処理を実行するオブジェクトを登録します。
...ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
event.handler = IeHandler.new
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if event.handler.completed
WIN32OLE_EVENT.message_loop
end
ie.Quit
WIN32OLE_EVENT#... -
WIN32OLE
_ EVENT # off _ event(event = nil) -> () (7.0) -
WIN32OLE_EVENT#on_eventで登録したブロックを解除します。
...WIN32OLE_EVENT#on_eventで登録したブロックを解除します。
@param event 文字列またはシンボルで登録時に指定したイベント名を指定しま
す。nilの場合、WIN32OLE_EVENT#on_eventに対してnilを指定したブロッ
クを解除します。
ev = WIN32OLE_... -
WIN32OLE
_ EVENT # on _ event(event = nil) {|*args| . . . } -> () (7.0) -
イベント通知を受けるブロックを登録します。
...は、
WIN32OLE_EVENT#on_event_with_outargsを利用してください。
@raise WIN32OLERuntimeError WIN32OLE_EVENT#unadviseによってイベン
トソースと切断済みです。
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.......、通知されたイベントに対応するブロックがあれば
そちらだけが呼び出されます。
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
ev.on_event("NavigateComplete2") do |browser, url|
puts url
end
ev.on_e... -
WIN32OLE
_ EVENT # on _ event _ with _ outargs(event = nil) {|*args| . . . } -> () (7.0) -
イベント通知を受けて結果を呼び出し元へ返すブロックを登録します。
...ッド名を指定します。引数を省略した場合は、すべて
のイベントを対象とするブロックの登録となります。
WIN32OLE_EVENT#on_eventと異なり、イベントのブロック変数に戻り値を
設定できます。
@param event イベント名を文字列か......配列の形式で受けてください。
@raise WIN32OLERuntimeError WIN32OLE_EVENT#unadviseによってイベン
トソースと切断済みです。
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
ev.on_event... -
WIN32OLE
_ EVENT # unadvise -> () (7.0) -
イベント通知元をオブジェクトから切断します。
...知を受けられなくなります。また、このオブ
ジェクトを利用したWIN32OLE_EVENT#on_eventなどの呼び出しはエラー
(WIN32OLERuntimeErrorの通知)となります。
WIN32OLE_EVENTオブジェクトは一度生成すると、イベントハンドラが登録され... -
WIN32OLE
_ EVENT . message _ loop -> () (7.0) -
Windowsのメッセージポンプを実行します。
...ト処理は
Windowsメッセージを読み取ってディスパッチすることで通知されます。
ie = WIN32OLE.new('InternetExplorer.Application.1')
event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
b = false
event.on_event('DocumentComplete') do |disp, uri|
disp.document.......by-lang.org/ja/downloads/ など
end
disp.quit
b = true
end
ie.Navigate2 'http://www.ruby-lang.org/ja/'
loop do
break if b
WIN32OLE_EVENT.message_loop
end
なお、メソッド名はloopですが、呼び出し時および既にキューイングされたメッ
セージ... -
WIN32OLE
_ EVENT . new(ole , event = nil) -> WIN32OLE _ EVENT (7.0) -
OLEオートメーションサーバのイベント受信機構をオブジェクト化して返します。
...ト通知に利用するインター
フェイスを取得し、オブジェクトとして返します。
@param ole イベントの通知元のWIN32OLEオブジェクトを指定します。
@param event イベントのインターフェイスを示すインターフェイス名または......クトの既定のイベントインターフェイスを利用します。
@return 指定したオブジェクトのイベントを管理するWIN32OLE_EVENTオブジェクト。
@raise RuntimeError eventパラメータで指定したIIDが見つかりません。また
はオ......た例
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
インターフェイス名を指定した例
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents2')
IIDを指定した例
ie = WIN32OLE.new('Internet... -
WIN32OLE
_ METHOD (7.0) -
OLEオートメーションサーバが持つメソッドの情報を提供します。
...提供します。
WIN32OLE_METHODは、WIN32OLE#ole_methodsなどの呼び出しによって返さ
れるオブジェクトで、OLEオートメーションサーバのメソッドの情報(メタデー
タ)を保持します。
=== サンプルコード
excel = WIN32OLE.new('Excel.Applic.......name}(#{
method.params.map {|p| "#{p.ole_type} #{p.name}"}.join(', ')
}) : #{method.helpstring}
SIGNATURE
end
end
@see WIN32OLE#ole_methods, WIN32OLE#ole_func_methods, WIN32OLE#ole_get_methods, WIN32OLE#ole_put_methods, WIN32OLE#ole_method, WIN32OLE#ole_method_help, WIN32OLE_PARAM... -
WIN32OLE
_ METHOD # dispid -> Integer (7.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 (7.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 (7.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 # helpcontext -> Integer | nil (7.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 (7.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 # helpstring -> String | nil (7.0) -
メソッドのヘルプ文字列を取得します。
...明する文字列です。
@return ヘルプ文字列を返します。未定義ならばnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL or file.... -
WIN32OLE
_ METHOD # invkind -> Integer (7.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 (7.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 # name -> String (7.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 (7.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] (7.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 (7.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 _ type _ detail -> [String] (7.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 # return _ vtype -> Integer (7.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 (7.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 (7.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 (7.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 (7.0) -
このメソッドがクライアントに対して公開されているか(可視性を持つか)ど うかを返します。
...て公開されているか(可視性を持つか)ど
うかを返します。
@return メソッドが公開されていれば真。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.visible? # => true...