検索結果

WIN32OLE_METHOD.new(ole_type, method) -> WIN32OLE_METHOD (7.0)

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

WIN32OLE_PARAM (7.0)

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

WIN32OLE_PARAM#default -> object | nil (7.0)

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

WIN32OLE_PARAM#input? -> bool (7.0)

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

WIN32OLE_PARAM#name -> String (7.0)

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

絞り込み条件を変える

WIN32OLE_PARAM#ole_type -> String (7.0)

• 2.2.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::VARIANT
• WIN32OLE_PARAM

WIN32OLE_PARAM#ole_type_detail -> [String] (7.0)

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

WIN32OLE_PARAM#optional? -> bool (7.0)

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

WIN32OLE_PARAM#output? -> bool (7.0)

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

• WIN32OLE_PARAM

WIN32OLE_PARAM#retval? -> bool (7.0)

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

絞り込み条件を変える

WIN32OLE_PARAM#to_s -> String (7.0)

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

WIN32OLE_PARAM.new(ole_method, index) -> WIN32OLE_PARAM (7.0)

• 2.2.0

• 特異メソッド

メソッドとパラメータ位置を指定してWIN32OLE_PARAMのインスタンスを作成します。

...メソッドとパラメータ位置を指定してWIN32OLE_PARAMのインスタンスを作成します。

アプリケーションプログラムでは、WIN32OLE_PARAMオブジェクトをnewメソッド
で生成するよりも、WIN32OLE_METHOD#paramsを参照するほうが簡単です。

@...

...ラメータがWIN32OLE_METHODのインスタンスではありません。
@raise IndexError indexパラメータが1からパラメータの数の範囲にありません。
@raise RuntimeError 該当メソッドのメタデータが取得できません。


excel = WIN32OLE.new('Excel.Applica...

...tion')
method = excel.ole_method('Run')
param1 = WIN32OLE_PARAM.new(method, 1)
puts "#{param1.ole_type} #{param1.name}"...

• WIN32OLE_METHOD
• WIN32OLE_PARAM

WIN32OLE_TYPE (7.0)

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

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (7.0)

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

WIN32OLE_TYPE#default_ole_types -> [WIN32OLE_TYPE] (7.0)

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

絞り込み条件を変える

WIN32OLE_TYPE#guid -> String | nil (7.0)

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

WIN32OLE_TYPE#helpcontext -> Integer | nil (7.0)

• 2.2.0

• インスタンスメソッド

この型に関連するヘルプファイルのトピックID（ヘルプコンテキスト）を取得 します。

...。

@return 型に関連するヘルプコンテキストを整数で返します。ヘルプコンテキ
ストが登録されていない場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpcontext # => 131185...

• WIN32OLE_TYPE

WIN32OLE_TYPE#helpfile -> String | nil (7.0)

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

WIN32OLE_TYPE#helpstring -> String | nil (7.0)

• 2.2.0

• インスタンスメソッド

型のドキュメント文字列を取得します。

...メント文字列を取得します。

@return ドキュメント文字列を返します。未定義の場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
p tobj.helpstring # => "Web Browser interface"

ドキュメント文字列は、コ...

• WIN32OLE_TYPE

WIN32OLE_TYPE#implemented_ole_types -> [WIN32OLE_TYPE] (7.0)

• 2.2.0

• インスタンスメソッド

この型が実装するインターフェイスを取得します。

...ーフェイスをWIN32OLE_TYPEの
配列として返します。この型がインターフェイスを実装しない場合は、
空配列を返します。

@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。

tobj = WIN32OLE_TYPE.new('Microso...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#inspect -> String (7.0)

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

WIN32OLE_TYPE#major_version -> Integer (7.0)

• 2.2.0

• インスタンスメソッド

型のメジャーバージョン番号を取得します。

...取得します。

@return 型のメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Object Library', 'Documents')
p tobj.major_version # => 8...

• WIN32OLE_TYPE

WIN32OLE_TYPE#minor_version -> Integer (7.0)

• 2.2.0

• インスタンスメソッド

型のマイナーバージョン番号を取得します。

...取得します。

@return 型のマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError 型属性の読み取りに失敗すると通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Word 14.0 Object Library', 'Documents')
p tobj.minor_version # => 5...

• WIN32OLE_TYPE

WIN32OLE_TYPE#name -> String (7.0)

• 2.2.0

• インスタンスメソッド

selfの型名を取得します。

...selfの型名を取得します。

@return selfの型名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"...

• WIN32OLE_TYPE

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (7.0)

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

絞り込み条件を変える

WIN32OLE_TYPE#ole_type -> String | nil (7.0)

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

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (7.0)

• 2.2.0

• インスタンスメソッド

この型を登録してある型情報ライブラリ（TypeLib）を取得します。

...TypeLib）を取得します。

@return この型を登録しているTypeLibをWIN32OLE_TYPELIBオブジェクト
として返します。見つからない場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.ole_typel...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPE#progid -> String | nil (7.0)

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

WIN32OLE_TYPE#source_ole_types -> [WIN32OLE_TYPE] (7.0)

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

WIN32OLE_TYPE#src_type -> String | nil (7.0)

• 2.2.0

• インスタンスメソッド

selfが他の型の別名ならば、元の型名を取得します。

...ます。

@return selfが別名ならば元の型名を文字列で返します。別名でなければnilを
返します。

tobj = WIN32OLE_TYPE.new('Microsoft Office 14.0 Object Library', 'MsoRGBType')
p tobj.src_type # => "I4"

この例は、OfficeのMsoRGBType型は符号付...

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#to_s -> String (7.0)

• 2.2.0

• インスタンスメソッド

selfの型名を取得します。

...selfの型名を取得します。

@return selfの型名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.name # => "Application"...

• WIN32OLE_TYPE

WIN32OLE_TYPE#typekind -> Integer (7.0)

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

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (7.0)

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

WIN32OLE_TYPE#visible? -> bool (7.0)

• 2.2.0

• インスタンスメソッド

この型が公開されているかどうかを照会します。

...この型が公開されているかどうかを照会します。

@return 公開されていれば真を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
p tobj.visible? # => true...

• WIN32OLE_TYPE

WIN32OLE_TYPE.new(libname, ole_class) -> WIN32OLE_TYPE (7.0)

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

絞り込み条件を変える

WIN32OLE_TYPE.ole_classes(libname) -> [WIN32OLE_TYPE] (7.0)

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

WIN32OLE_TYPE.progids -> [String] (7.0)

• 2.2.0

• 特異メソッド

システムに登録されているすべてのコンポーネントクラスのPROGIDを取得します。

...スのPROGIDを
文字列配列で返します。

excel = nil
WIN32OLE_TYPE.progids.each do |pg|
if pg =~ /excel\.application/i # ExcelのPROGIDをバージョン無視で取り出す
excel = WIN32OLE.new(pg)
break
end
end
unless excel
$stderr.puts "Excel i...

...exit(1)
end
excel.visible = true
# ...
excel.Quit

PROGIDは、生成可能なOLEオートメーションサーバのCoClass（コンポーネント
クラス）が持つレジストリ登録名です。WIN32OLE.newの引数に指定して
WIN32OLEオブジェクトを生成できます。...

• WIN32OLE_TYPE

WIN32OLE_TYPE.typelibs -> [String] (7.0)

• 2.2.0

• 特異メソッド

システムに登録されているすべてのTypeLibのドキュメント文字列を取得します。

...メント文字列の配
列を返します。

Ruby-1.9.1からは、すべてのTypeLibのドキュメント文字列を取得するには、
WIN32OLE_TYPELIBオブジェクトを利用して、以下のように記述してくだ
さい。

WIN32OLE_TYPELIB.typelibs.map {|t| t.name}...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB (7.0)

• 2.2.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_TYPELIB#guid -> String (7.0)

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

絞り込み条件を変える

WIN32OLE_TYPELIB#library_name -> String (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibのヘルプファイル用ドキュメント文字列からTypeLibの名前を取得します。

...名前を取得します。

@return TypeLibの名前を文字列で返します。
@raise WIN32OLERuntimeError ドキュメント文字列が取得できなかった場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
tlib.library_name # => Excel...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#major_version -> Integer (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibのメジャーバージョン番号を取得します。

...取得します。

@return TypeLibのメジャーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.major_version # => 1...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#minor_version -> Integer (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibのマイナーバージョン番号を取得します。

...取得します。

@return TypeLibのマイナーバージョン番号を整数で返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.minor_version # => 7...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#name -> String (7.0)

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

WIN32OLE_TYPELIB#ole_classes -> [WIN32OLE_TYPE] (7.0)

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

絞り込み条件を変える

WIN32OLE_TYPELIB#ole_types -> [WIN32OLE_TYPE] (7.0)

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

WIN32OLE_TYPELIB#path -> String (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibのパス名を取得します。

...、Windowsのパス名形式（ディレクトリ区切りは「\」）
です。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.path # => 'C:\...\EXCEL.EXE'

Typ...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#to_s -> String (7.0)

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

WIN32OLE_TYPELIB#version -> Float (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibのバージョン番号を取得します。

...号、小数点
数部にマイナーバージョン番号を設定したFloatで返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.version # => 1.7...

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#visible? -> bool (7.0)

• 2.2.0

• インスタンスメソッド

TypeLibの情報が公開情報かどうかを照会します。

...とみなして偽を返します。

@return TypeLibが公開可能であれば真を返します。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.visible? # => true...

• WIN32OLE_TYPELIB

絞り込み条件を変える

WIN32OLE_TYPELIB.new(libname, mjv = nil, miv = nil) -> WIN32OLE_TYPELIB (7.0)

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

WIN32OLE_TYPELIB.typelibs -> [WIN32OLE_TYPELIB] (7.0)

• 2.2.0

• 特異メソッド

システムに登録されているすべてのTypeLibを取得します。

...システムに登録されているすべてのTypeLibを取得します。

@return 登録されているすべてのTypeLibを元にWIN32OLE_TYPELIBオブジェクト
の配列を返します。

tlibs = WIN32OLE_TYPELIB.typelibs...

• WIN32OLE_TYPELIB

WIN32OLE_VARIABLE (7.0)

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

WIN32OLE_VARIABLE#name -> String (7.0)

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

WIN32OLE_VARIABLE#ole_type -> String (7.0)

• 2.2.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::VARIANT
• WIN32OLE_VARIABLE

絞り込み条件を変える

WIN32OLE_VARIABLE#ole_type_detail -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

変数の型と属性を取得します。

...列で返します。

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で未定義なので変...

...eBits
UI4 [UI4] reserved

上例のように、WIN32OLE_VARIABLEで取得できる変数あるいはその元となる構造
体は、必ずしもOLEオートメーション互換データというわけではありません。こ
のようなデータはWIN32OLEからは利用できません。...

• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#to_s -> String (7.0)

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

WIN32OLE_VARIABLE#value -> object | nil (7.0)

• 2.2.0

• インスタンスメソッド

変数の値を取得します。

...このような定数値を返します。

@return この変数が持つ定数値。値を持たない場合はnilを返します。


tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
variables = tobj.variables
variables.each do |variable|
puts "#{variabl...

• WIN32OLE_VARIABLE

WIN32OLE_VARIABLE#variable_kind -> String (7.0)

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

WIN32OLE_VARIABLE#varkind -> Integer (7.0)

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

絞り込み条件を変える

WIN32OLE_VARIABLE#visible? -> bool (7.0)

• 2.2.0

• インスタンスメソッド

変数の可視性を取得します。

...変数の可視性を取得します。

@return publicアクセス可能であれば真を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
puts tobj.variables.map {|v| v.visible?}.uniq # => true...

• WIN32OLE_VARIABLE

WIN32OLE_VARIANT (7.0)

• 2.2.0

• クラス

OLEオートメーションの標準型のVARIANTオブジェクトをRubyで利用するための クラスです。

...報は、WIN32OLE_VARIANT#vartypeで取得できます。
* 値は、WIN32OLE_VARIANT#valueで取得できます。

OLEオートメーションのメソッド呼び出し規約では、引数はVARIANT型の配列と
して定義されています。

この規約に対して、WIN32OLEでは、VA...

...この場合、WIN32OLEの実装は正しく処理されません。

WIN32OLE_VARIANTオブジェクトを利用すると、このようなOLEオートメーション
サーバのメソッド呼び出しに対して、VARIANT型の値を引数配列に設定すること
をWIN32OLEへ指示でき...

...ます。

なお、WIN32OLE_VARIANTを利用する必要の有無は、呼び出し対象のOLEオートメー
ションサーバの仕様または実装に依存します。

=== サンプルコード

shell = WIN32OLE.new('Shell.Application')
folder = shell.NameSpace('C:\\Users\\Public\\Doc...

WIN32OLE_VARIANT#[](i...) -> object (7.0)

• 2.2.0

• インスタンスメソッド

配列型のWIN32OLE_VARIANTの要素を取得します。

...配列型のWIN32OLE_VARIANTの要素を取得します。

selfは、WIN32OLE_VARIANT.arrayまたは引数に配列を指定して
WIN32OLE_VARIANT.newで作成したインスタンスの必要があります。

@param i 各次元の0からのインデックスを「,」で区切って次元数分...

...ていません。

@raise WIN32OLERuntimeError selfが配列型のWIN32OLE_VARIANTではありませ
ん。あるいはインデックスが0未満または要素数
以上を指定しています。

obj = WIN32OLE_VARIANT.new([[1,2,3],[4,...

...5,6]])
p obj[0,0] # => 1
p obj[1,0] # => 4
p obj[2,0] # => WIN32OLERuntimeError
p obj[0, -1] # => WIN32OLERuntimeError...

• WIN32OLE_VARIANT

WIN32OLE_VARIANT#[]=(i..., val) -> object (7.0)

• 2.2.0

• インスタンスメソッド

配列型のWIN32OLE_VARIANTの要素を設定します。

...配列型のWIN32OLE_VARIANTの要素を設定します。

selfは、WIN32OLE_VARIANT.arrayまたは引数に配列を指定して
WIN32OLE_VARIANT.newで作成したインスタンスの必要があります。

@param i 各次元の0からのインデックスを「,」で区切って次元数分...

...ンオブジェクト（WIN32OLEオブジェクト）に変換します。
@return 引数で指定したインデックスの要素を返します。
@raise ArgError 引数の数が次元数と一致していません。

@raise WIN32OLERuntimeError selfが配列型のWIN32OLE_VARIANTではありま...

...が0未満または要素数
以上を指定しています。

obj = WIN32OLE_VARIANT.new([[1,2,3],[4,5,6]])
obj[0,0] = 7
obj[1,0] = 8
p obj.value # => [[7,2,3], [8,5,6]]
obj[2,0] = 9 # => WIN32OLERuntimeError
obj[0, -1] = 9 # => WIN32OLERuntimeError...

• WIN32OLE_VARIANT

WIN32OLE_VARIANT#value -> object (7.0)

• 2.2.0

• インスタンスメソッド

値に対応するRubyオブジェクトを取得します。

...値に対応するRubyオブジェクトを取得します。

@return 値に対応するRubyのオブジェクトを返します。

obj = WIN32OLE_VARIANT.new(1, WIN32OLE::VARIANT::VT_BSTR)
obj.value # => "1" (VT_BSTRを指定して生成したので、Stringオブジェクトとなる)...

• WIN32OLE_VARIANT

絞り込み条件を変える

WIN32OLE_VARIANT#value=(val) -> () (7.0)

• 2.2.0

• インスタンスメソッド

WIN32OLE_VARIANTの値を再設定します。

...WIN32OLE_VARIANTの値を再設定します。

指定した値でselfを再設定します。指定値が元のVARIANT型に合わない場合は元
のVARIANT型に合うように引数を変換します。変換は、引数を一度VARIANT型に
変換してからCOMのVARIANT型変換関数（Va...

...ます。

@param val 設定値を指定します。
@raise WIN32OLERuntimeError selfが配列型です。あるいは、型変換に失敗し
ました。

obj = WIN32OLE_VARIANT.new(1) # VARIANT型にWIN32OLE::VARIANT::VT_I4を設定
obj.value = 3.2 # 3.2か...

...p obj.value # => 3 # VT_I4に変換した結果が設定される

selfが配列型のWIN32OLE_VARIANTの場合、バイト配列かつ引数が文字列の場合
を除いてWIN32OLERuntimeErrorを通知します。配列型の場合は、
WIN32OLE_VARIANT#[]=を利用してください。...

• WIN32OLERuntimeError
• WIN32OLE_VARIANT

WIN32OLE_VARIANT#vartype -> Integer (7.0)

• 2.2.0

• インスタンスメソッド

selfの型情報を取得します。

...す。

型情報は、WIN32OLE::VARIANTの定数値の組み合わせです。

obj = WIN32OLE_VARIANT.new("string")
obj.vartype # => 8 (WIN32OLE::VARIANT::VT_BSTR)
bytes = WIN32OLE_VARIANT.new([1,2,3,4,5], VT_UI1 | VT_ARRAY)
bytes.vartype # => 8209 (WIN32OLE::VARIANT::VT_ARRAY | VT_U...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

WIN32OLE_VARIANT.array(dims, vt) -> WIN32OLE_VARIANT (7.0)

• 2.2.0

• 特異メソッド

配列用のVARIANTオブジェクトを生成します。

...WIN32OLE::VARIANTの定数で指定します。
@return 指定された次元/要素数を持つWIN32OLE_VARIANTオブジェクト。

次の例は、最初の次元が3要素、次の次元が4要素の2次元配列を生成する例です。

ole_ary = WIN32OLE_VARIANT.array([3,4], WIN32OLE::VA...

...RIANT::VT_I4)
ruby_ary = ole_ary.value # => [[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0]]

@see WIN32OLE_VARIANT#value, WIN32OLE::VARIANT...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

WIN32OLE_VARIANT.new(val, vartype = nil) -> WIN32OLE_VARIANT (7.0)

• 2.2.0

• 特異メソッド

指定したオブジェクトを値とするWIN32OLE_VARIANTオブジェクトを生成します。

...ジェクトを値とするWIN32OLE_VARIANTオブジェクトを生成します。

@param val ラップするRubyオブジェクトを指定します。
@param vartype 省略時はWIN32OLEが自動型変換を行います。指定する場合は
WIN32OLE::VARIANTの定数を指定し...

...持つWIN32OLE_VARIANTオブジェクトを返します。

@raise TypeError val引数の型がArray、String、Integer、Float、Time、
WIN32OLE、WIN32OLE_VARIANT、TrueClass、FalseClass、
NilClass のいずれでもありません。

shell = WIN32OLE.new('...

...Shell.Application')
folder = shell.NameSpace('C:\\Users\\Public\\Documents')
item = folder.ParseName('test.txt')
v = WIN32OLE_VARIANT.new('Delete')
item.invokeVerb(v) # => ゴミ箱への移動ダイアログを表示

バイト配列を生成するには、以下のようにvartype...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

WIN32OLE_VARIANT::Empty -> WIN32OLE_VARIANT (7.0)

• 2.2.0

• 定数

EMPTY型のWIN32OLE_VARIANTオブジェクトです。

...EMPTY型のWIN32OLE_VARIANTオブジェクトです。

このオブジェクトは、VOID型の戻り値や、値が空なことを明示しなければなら
ない特殊な引数に利用します。

@see WIN32OLE::VARIANT::VT_EMPTY...

• WIN32OLE_VARIANT

絞り込み条件を変える

WIN32OLE_VARIANT::Nothing -> WIN32OLE_VARIANT (7.0)

• 2.2.0

• 定数

DISPATCH型の空のオブジェクトです。

...DISPATCH型の空のオブジェクトです。

@see WIN32OLE::VARIANT::VT_DISPATCH...

• WIN32OLE_VARIANT

WIN32OLE_VARIANT::Null -> WIN32OLE_VARIANT (7.0)

• 2.2.0

• 定数

NULL型のWIN32OLE_VARIANTオブジェクトです。

...NULL型のWIN32OLE_VARIANTオブジェクトです。

このオブジェクトは、ADOなどのデータベースインターフェイスでNULLを指定す
るのに利用可能です。

@see WIN32OLE::VARIANT::VT_NULL...

• WIN32OLE_VARIANT