るりまサーチ (Ruby 2.5.0)

最速Rubyリファレンスマニュアル検索!
70件ヒット [1-70件を表示] (0.155秒)

別のキーワード

  1. win32ole new
  2. win32ole ole_type
  3. win32ole to_s
  4. win32ole name
  5. win32ole ole_free

検索結果

WIN32OLE_TYPE#ole_type -> String | nil (90679.0)

selfの型の種類(TYPEKIND)を取得します。

selfの型の種類(TYPEKIND)を取得します。

@return selfの型の種類を文字列で返します。情報が取得できない場合はnilを返します。

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

ole_typeには以下があります。

: Enum
列挙子(0)
: Record
ユーザ定義型(メソッドを持たない構造体)(1)
: Module
モジュール(静的関数やデータだけを保持)(2)
: In...

WIN32OLE_VARIABLE#ole_type -> String (90643.0)

変数の型を取得します。

変数の型を取得します。

@return 変数の型名を文字列で返します。型名を文字列に変換できない場合は、
「Unknown Type nn」(nnはバリアント型を示す数値)の形式の文字列
を返します。

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

WIN32OLE_PARAM#ole_type -> String (81643.0)

パラメータの型名を取得します。

パラメータの型名を取得します。

@return パラメータの型名を示す文字列を返します。
パラメータの型情報が見つからない場合は、"unknown type"を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.ole_type # => VARIANT

OLEオートメーション...

WIN32OLE_TYPE#implemented_ole_types -> [WIN32OLE_TYPE] (73543.0)

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

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

implemented_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスが実装しているすべてのインターフェイスを返します。

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

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

tobj = WIN32OLE_TYPE.new('Micro...

WIN32OLE#ole_type -> WIN32OLE_TYPE | nil (73315.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_TYPE#source_ole_types -> [WIN32OLE_TYPE] (55243.0)

型が持つソースインターフェイスを取得します。

型が持つソースインターフェイスを取得します。

source_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)の場合、
そのクラスがサポートするすべてのソースインターフェイス(イベントの通知
元となるインターフェイス)を返します。

ActiveXコントロールのようにイベント(WIN32OLE_EVENT)をサポートし
ているコンポーネントクラスの場合は、このメソッドの呼び出しによりイベン
トインターフェイスを調べることが可能です。

@return ソースインターフェイスをWIN32OLE_TYPEの配列として返します。
ソースインターフェイスを...

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (55222.0)

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

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

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

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

WIN32OLE_TYPE#default_ole_types -> [WIN32OLE_TYPE] (54943.0)

型が持つデフォルトのインターフェイスを取得します。

型が持つデフォルトのインターフェイスを取得します。

default_ole_typesメソッドは、selfがCoClass(コンポーネントクラス)の場
合、そのクラスが実装しているデフォルトのインターフェイスと、サポートし
ていればデフォルトのソースインターフェイスを返します。

@return デフォルトインターフェイスをWIN32OLE_TYPEの配列として返し
ます。デフォルトインターフェイスは、最大でも、クラス操作用のイ
ンターフェイス(OLEオートメーション用)と、イベント用のソースイ
ンターフェイスの2要素です。デフォルトインターフ...

WIN32OLE_VARIABLE#ole_type_detail -> [String] (54661.0)

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

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

@return 変数の型と属性を文字列配列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft XML, v5.0', 'tagSTATSTG')
tobj.variables.each do |v|
puts "#{v.ole_type} [#{v.ole_type_detail.join(', ')}] #{v.name}"
end

出力結果

Unknown Type 31 [] pwcsName # => VT_LPWSTR はWIN32OLE::VARIANTで未定義なので変換でき...

WIN32OLE_TYPELIB#ole_types -> [WIN32OLE_TYPE] (46228.0)

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。

@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments...

絞り込み条件を変える

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (46204.0)

オブジェクトに対応する型情報ライブラリ(TypeLib)を WIN32OLE_TYPELIBとして返します。

オブジェクトに対応する型情報ライブラリ(TypeLib)を
WIN32OLE_TYPELIBとして返します。

OLEオートメーションではクラス、インターフェイス、メソッド、引数などの型
情報と文書情報を型情報ライブラリとして利用します。型情報ライブラリは独
立したファイル(拡張子tlb)の場合もあれば、オブジェクトのバイナリへリソー
スとして埋め込まれている場合があります。

OLEオートメーションでは型情報ライブラリの提供方法を問わずに統一したイン
ターフェイスでアプリケーションが参照できるように、オブジェクトの形式
(ITypeInfoインターフェイス)で提供します。WIN32OLEは...

WIN32OLE_PARAM#ole_type_detail -> [String] (45643.0)

パラメータの属性を取得します。

パラメータの属性を取得します。

@return 型の属性を文字列配列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'IWorksheetFunction')
method = WIN32OLE_METHOD.new(tobj, 'SumIf')
param1 = method.params[0]
p param1.ole_type_detail # => ["PTR", "USERDEFINED", "Range"]

パラメータの取り得る属性値はCOMのIDL(インターフ...

WIN32OLE_TYPELIB#ole_classes -> [WIN32OLE_TYPE] (36928.0)

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されているすべての型を取得します。

TypeLibに格納されている型には、クラス(CoClass——コンポーネントクラス)
やEnum(列挙子)、構造体などがあります。

@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェ
クトの配列として返します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
classes = tlib.ole_types.map{|k| k.name} # => ["Adjustments...

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (36922.0)

型が持つ変数を取得します。

型が持つ変数を取得します。

型がEnum(列挙型)やユーザ定義型の場合、メンバ変数の情報を
WIN32OLE_VARIABLEオブジェクトの配列として返します。

@return 型が持つ変数情報をWIN32OLE_VARIABLEの配列として返します。
変数を持たない場合は空配列を返します。
@raise WIN32OLERuntimeError 型属性が取得できない場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'XlSheetType')
vars = to...

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (36622.0)

型が持つメソッドのメタデータを取得します。

型が持つメソッドのメタデータを取得します。

@return 型が持つメソッドのメタデータをWIN32OLE_METHODの配列として返します。
メソッドを持たない場合は空配列を返します。


tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
methods = tobj.ole_methods.map {|m| m.name }
# => ['QueryInterface', 'AddRef', 'Release',.....

絞り込み条件を変える

WIN32OLE_TYPE#helpfile -> String | nil (36322.0)

オブジェクトに関連付けられたヘルプファイルのフルパス名。

オブジェクトに関連付けられたヘルプファイルのフルパス名。

ここで返されたヘルプファイルを表示するには、
WIN32OLE#ole_show_helpメソッドを呼び出します。

オブジェクトがヘルプファイルを持たない場合はnilを返します。

@return オブジェクトに関連付けられたヘルプファイルのフルパス名を文字列で返します。
ヘルプファイルが未定義の場合はnilを返します。

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

WIN32OLE_TYPE#visible? -> bool (36322.0)

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

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

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

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

WIN32OLE_VARIABLE#variable_kind -> String (36322.0)

変数の種類(VARKIND)を取得します。

変数の種類(VARKIND)を取得します。

この変数の種類を示す文字列を返します。

@return VARKINDに対応する文字列を返します。

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

返送値は以下のいずれかとなります。

: PERINSTANCE
インスタンス毎の変数。構造体やユーザ定義体のフィールド。(0)
: STATI...

WIN32OLE_VARIABLE#visible? -> bool (36322.0)

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

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

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

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

WIN32OLE_TYPELIB#visible? -> bool (36304.0)

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

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

このメソッドは、TypeLibの属性(TLIBATTR)のフラグ値が0、制限
(LIBFLAG_FRESTRICTED)、コントロール内部使用(LIBFLAG_FHIDDEN)のいずれか
であれば非公開TypeLibとみなして偽を返します。

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

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Li...

絞り込み条件を変える

WIN32OLE#ole_obj_help -> WIN32OLE_TYPE | nil (28015.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_TYPE#default_event_sources -> [WIN32OLE_TYPE] (27715.0)

型が持つソースインターフェイスを取得します。

型が持つソースインターフェイスを取得します。

default_event_sourcesメソッドは、selfがCoClass(コンポーネントクラス)
の場合、そのクラスがサポートするデフォルトのソースインターフェイス(イ
ベントの通知元となるインターフェイス)を返します。

@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。

tobj = ...

WIN32OLE_METHOD#helpfile -> String | nil (27322.0)

ヘルプファイルのパス名を取得します。

ヘルプファイルのパス名を取得します。

メソッドにヘルプファイルが関連付けられている場合、該当ヘルプファイルの
パス名を返します。

@return ヘルプファイルのパス名を文字列で返します。ヘルプファイルが未定
義ならばnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpfile # => C:\...\VBAXL9.CH...

WIN32OLE_METHOD#visible? -> bool (27322.0)

このメソッドがクライアントに対して公開されているか(可視性を持つか)ど うかを返します。

このメソッドがクライアントに対して公開されているか(可視性を持つか)ど
うかを返します。

@return メソッドが公開されていれば真。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.visible? # => true

WIN32OLE_TYPE#helpcontext -> Integer | nil (27322.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPE#helpstring -> String | nil (27322.0)

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

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

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

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

ドキュメント文字列は、コンテキストヘルプなどに利用可能な型の簡単な説明文です。

WIN32OLE_VARIABLE#value -> object | nil (27322.0)

変数の値を取得します。

変数の値を取得します。

変数情報によってはenum値のように定数値を持つものがあります。valueメソッ
ドはこのような定数値を返します。

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


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

WIN32OLE_TYPELIB#library_name -> String (27304.0)

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

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

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

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

WIN32OLE_METHOD#helpcontext -> Integer | nil (18322.0)

メソッドのヘルプコンテキストを取得します。

メソッドのヘルプコンテキストを取得します。

ヘルプコンテキストは、関連するヘルプファイル上のトピック位置を示す整数
値です。

@return ヘルプコンテキストを返します。未定義の場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpcontext # => 65717

WIN32OLE_METHODオブジェクトを引数として、WI...

WIN32OLE_METHOD#helpstring -> String | nil (18322.0)

メソッドのヘルプ文字列を取得します。

メソッドのヘルプ文字列を取得します。

helpstringは、IDEがメソッドのバルーンヘルプを表示するような場合に利用可
能な、1行程度でメソッドを説明する文字列です。

@return ヘルプ文字列を返します。未定義ならばnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL o...

絞り込み条件を変える

WIN32OLE_METHOD#offset_vtbl -> Integer (18322.0)

このメソッドのVTBLのオフセットを取得します。

このメソッドのVTBLのオフセットを取得します。

VTBLはC++やCでメソッドを呼び出すために利用する関数ポインタのテーブルです。

@return メソッドのVTBL上のオフセットを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.offset_vtbl # => 40

WIN32OLE_METHOD#return_type_detail -> [String] (18322.0)

返り値の型と属性を取得します。

返り値の型と属性を取得します。

@return 返り値の型と属性を文字列配列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Workbooks')
p method.return_type_detail # => ["PTR", "USERDEFINED", "Workbooks"]

属性が付加されていない場合は、WIN32OLE_METHOD#return_typeを要素と
...

WIN32OLE_PARAM#default -> object | nil (18322.0)

パラメータを指定しなかった場合の既定値を取得します。

パラメータを指定しなかった場合の既定値を取得します。

当パラメータが必須パラメータの場合はnilを返します。

@return パラメータを指定しなかった場合の既定値。必須パラメータならばnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
method.params.each do |param|
if param.default
puts "...

WIN32OLE_PARAM#optional? -> bool (18322.0)

パラメータがオプションかどうかを取得します。

パラメータがオプションかどうかを取得します。

@return パラメータがオプション(省略可能)であれば真を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts "#{param1.name} #{param1.optional?}" # => Filename true

WIN32OLE_PARAM#retval? -> bool (18322.0)

パラメータが戻り値かどうかを判定します。

パラメータが戻り値かどうかを判定します。

OLEオートメーションの規定では、メソッドの戻り値は引数リストの最右端のパ
ラメータをout属性(WIN32OLE_PARAM#output?が真)とすることで実現し
ます。ただし、そのパラメータをOLEオートメーション呼び出しを記述する言語
が戻り値のように扱うか、それとも引数リストに並べるかはretval属性によっ
て決定されます。

retval?メソッドは、戻り値として記述する場合に真となります。

@return パラメータが戻り値として扱われる場合に真を返します。

tobj = WIN32OLE_TYPE.new('DirectX...

絞り込み条件を変える

WIN32OLE_TYPE#guid -> String | nil (18322.0)

この型のGUID(グローバル一意識別子)を取得します。

この型の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のクラス識別子(CLSID)、インターフェイス識別子(IID)など多数の
領域でWindows上のオブジェクトの識別に利用される128ビットの...

WIN32OLE_TYPE#progid -> String | nil (18322.0)

selfのPROGIDを取得します。

selfのPROGIDを取得します。

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

@return selfのPROGIDを文字列で返します。selfがPROGIDを持たない、または
CoClassでない場合はnilを返します。

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

WIN32OLE_TYPE#src_type -> String | nil (18322.0)

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

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

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

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

この例は、OfficeのMsoRGBType型は符号付き32ビット整数(I4)の別名だとい
うことを示します。

WIN32OLE_TYPELIB#version -> Float (18304.0)

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

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

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

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

WIN32OLE_TYPE#inspect -> String (18094.0)

selfを説明的な文字列で表現します。

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#typekind -> Integer (18094.0)

selfの種類を示す値を取得します。

selfの種類を示す値を取得します。

値の意味については、WIN32OLE_TYPE#ole_typeを参照してください。

@return 型の種類を示す数値を返します。
@raise WIN32OLERuntimeError 型の種類(TYPEKIND)を取得できない場合に通知します。

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

@see WIN32OLE_TYPE#ole_type

WIN32OLE_TYPE#major_version -> Integer (18022.0)

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

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

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

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

WIN32OLE_TYPE#minor_version -> Integer (18022.0)

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

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

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

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

WIN32OLE_TYPE#name -> String (18022.0)

selfの型名を取得します。

selfの型名を取得します。

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

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

WIN32OLE_TYPE#to_s -> String (18022.0)

selfの型名を取得します。

selfの型名を取得します。

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

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

絞り込み条件を変える

WIN32OLE_VARIABLE#name -> String (18022.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#to_s -> String (18022.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#varkind -> Integer (18022.0)

変数の種類(VARKIND)を取得します。

変数の種類(VARKIND)を取得します。

この変数の種類を示す数値を返します。

@return VARKINDに対応する数値を返します。

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

数値の意味については、WIN32OLE_VARIABLE#variable_kindの説明を参照してください。

WIN32OLE_TYPELIB#guid -> String (18004.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-C000-000000000046}'

WIN32OLE_TYPELIB#major_version -> Integer (18004.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPELIB#minor_version -> Integer (18004.0)

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

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

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

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

WIN32OLE_TYPELIB#name -> String (18004.0)

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

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

ドキュメント文字列は、コンテキストヘルプなどに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。

@return TypeLibのドキュメント文字列を返します。

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

WIN32OLE_TYPELIB#path -> String (18004.0)

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

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

@return TypeLibのパス名を文字列で返します。この値はレジストリの登録値を
そのまま利用するため、Rubyのパス名形式(ディレクトリ区切りは
「/」)ではなく、Windowsのパス名形式(ディレクトリ区切りは「\」)
です。
@raise WIN32OLERuntimeError TypeLibの属性が読み取れない場合に通知します。

tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tli...

WIN32OLE_TYPELIB#to_s -> String (18004.0)

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

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

ドキュメント文字列は、コンテキストヘルプなどに利用可能なTypeLibの簡単な
説明文で、通常バージョン番号を含みます。

@return TypeLibのドキュメント文字列を返します。

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

WIN32OLE_METHOD#event? -> bool (9322.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 (9322.0)

メソッドがイベントの場合、イベントのインターフェイス名を取得します。

メソッドがイベントの場合、イベントのインターフェイス名を取得します。

@return メソッドがイベントであれば、イベントのインターフェイス名を返し
ます。イベントでなければnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event_interface # => WorkbookEvents

WIN32OLE_METHOD#params -> [WIN32OLE_PARAM] (9322.0)

メソッドのパラメータ情報を取得します。

メソッドのパラメータ情報を取得します。

このメソッドのパラメータをWIN32OLE_PARAMの配列として返します。配
列の最初の要素が最左端のパラメータに対応します。

@return WIN32OLE_PARAMの配列。無引数のメソッドであれば要素数0の配
列を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
p method.params # => ...

WIN32OLE_METHOD#size_opt_params -> Integer | nil (9322.0)

オプションパラメータ数を取得します。

オプションパラメータ数を取得します。

@return オプションパラメータ数を整数で返します。メソッドの詳細情報を取
得できない場合はnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_opt_params # => 5

WIN32OLE_METHOD#size_params -> Integer | nil (9322.0)

パラメータ数を取得します。

パラメータ数を取得します。

@return パラメータ数を整数で返します。メソッドの詳細情報を取得できない
場合はnilを返します。


tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_params # => 12

WIN32OLE_PARAM#input? -> bool (9322.0)

パラメータがクライアントからサーバへ与えるものかを判定します。

パラメータがクライアントからサーバへ与えるものかを判定します。

OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。

input?メソッドはin属性またはinout属性なら真を返します。

@return メソッドの方向属性がinまたはinoutならば真を返します。

tobj = WIN32OLE...

絞り込み条件を変える

WIN32OLE_PARAM#output? -> bool (9322.0)

パラメータがクライアントからの結果を受け取るためのものかを判定します。

パラメータがクライアントからの結果を受け取るためのものかを判定します。

OLEオートメーションのパラメータは、in(クライアントからサーバへ与える。
WIN32OLE_PARAM#input?が真)、out(サーバがクライアントへ与える。
WIN32OLE_PARAM#output?が真)および、inout(クライアントからサーバ
へ与え、サーバがクライアントへ与える)の3種類の方向属性のいずれかを持ち
ます。

output?メソッドはout属性またはinout属性なら真を返します。

@return メソッドの方向属性がoutまたはinoutならば真を返します。

tobj = W...

WIN32OLE_METHOD#dispid -> Integer (9022.0)

メソッドのディスパッチID(DISPID)を取得します。

メソッドのディスパッチID(DISPID)を取得します。

ディスパッチIDはメソッドの一意識別子です。WIN32OLEでは、
WIN32OLE#_invokeなどのメソッドで、呼び出すサーバのメソッドを指定
するのに利用します。

@return メソッドのDISPIDを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.dispid # => 181
...

WIN32OLE_METHOD#invkind -> Integer (9022.0)

メソッドの種類を示すINVOKEKIND列挙値を取得します。

メソッドの種類を示すINVOKEKIND列挙値を取得します。

ここで言うメソッドの種類というのは、OLEオートメーションクライアントの記
述言語がどのような形式でサーバ呼び出しを記述すべきかを指定した属性値で
す。

@return メソッドのINVOKEKINDを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invkind # => 1

INVOKE...

WIN32OLE_METHOD#invoke_kind -> String (9022.0)

メソッドの種類を文字列で取得します。

メソッドの種類を文字列で取得します。

ここで言うメソッドの種類というのは、OLEオートメーションクライアントの記
述言語がどのような形式でサーバ呼び出しを記述すべきかを指定した属性値で
す。

@return メソッドの種類を示す文字列を返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.invoke_kind # => "FUNC"

返送値は以下のい...

WIN32OLE_METHOD#name -> String (9022.0)

メソッド名を取得します。

メソッド名を取得します。

@return メソッド名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs

絞り込み条件を変える

WIN32OLE_METHOD#return_type -> String (9022.0)

メソッドの返り値の型名を取得します。

メソッドの返り値の型名を取得します。

@return 返り値の型名を示す文字列を返します。
@raise WIN32OLERuntimeError メソッドの型情報を取得できなかった場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Visible')
puts method.return_type # => BOOL

OLEオートメーションの型名は、対応するWIN32OLE...

WIN32OLE_METHOD#return_vtype -> Integer (9022.0)

メソッドの返り値の型を示す数値を取得します。

メソッドの返り値の型を示す数値を取得します。

@return 返り値の型を示す数値(VARENUM)を返します。
@raise WIN32OLERuntimeError メソッドの型情報を取得できなかった場合に通知します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
method = WIN32OLE_METHOD.new(tobj, 'Visible')
puts method.return_vtype # => 11

VARENUMの定義は、Platfo...

WIN32OLE_METHOD#to_s -> String (9022.0)

メソッド名を取得します。

メソッド名を取得します。

@return メソッド名を文字列で返します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.name # => SaveAs

WIN32OLE_PARAM#name -> String (9022.0)

パラメータ名を取得します。

パラメータ名を取得します。

@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename

WIN32OLE_PARAM#to_s -> String (9022.0)

パラメータ名を取得します。

パラメータ名を取得します。

@return パラメータ名を返します。名前付き引数形式でメソッドを呼び出すときに指定します。

tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts param1.name # => Filename

絞り込み条件を変える