るりまサーチ (Ruby 3.4)

最速Rubyリファレンスマニュアル検索!
84件ヒット [1-84件を表示] (0.047秒)
トップページ > バージョン:3.4[x] > クエリ:win32ole[x] > クエリ:ole_type[x]

別のキーワード

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

検索結果

WIN32OLE#ole_type -> WIN32OLE_TYPE | nil (97156.0)

[c:WIN32OLE_TYPE]オブジェクトを返します。

[c:WIN32OLE_TYPE]オブジェクトを返します。

[c:WIN32OLE_TYPE]オブジェクトは、WIN32OLEオブジェクトの文書情報と型情報を保持するオブジェクトです。

- **return** -- オブジェクトに関連する[c:WIN32OLE_TYPE]オブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。

```ruby
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
```

- **SEE** [c:WIN32OLE_TY...

WIN32OLE_TYPE#ole_type -> String | nil (96412.0)

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

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

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

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

ole_typeには以下があります。

- **`Enum`**:
列挙子(0)
- **`Record`**:
ユーザ定義型(メソッドを持たない構造体)(1)
- **`Mod...

WIN32OLE_PARAM#ole_type -> String (87412.0)

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

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

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

```ruby
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
```

OL...

WIN32OLE_VARIABLE#ole_type -> String (87376.0)

変数の型を取得します。

変数の型を取得します。

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

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

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (70024.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPE#source_ole_types -> [WIN32OLE_TYPE] (60997.0)

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

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

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

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

- **return** -- ソースインターフェイスを[c:WIN32OLE_TYPE]の配列として返します。
...

WIN32OLE_TYPE#default_ole_types -> [WIN32OLE_TYPE] (60979.0)

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

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

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

- **return** -- デフォルトインターフェイスを[c:WIN32OLE_TYPE]の配列として返します。デフォルトインターフェイスは、最大でも、クラス操作用のインターフェイス(OLEオートメーション用)と、イベント用のソースインターフェイスの2要素です。デフォルトインターフェイスを持たない場合は空配列を返...

WIN32OLE_TYPE#implemented_ole_types -> [WIN32OLE_TYPE] (60979.0)

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

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

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

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

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

```ruby
tobj = WIN32OLE_TYPE.n...

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (60958.0)

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

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

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

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

WIN32OLE_TYPE (60313.0)

WIN32OLE_TYPEオブジェクトは、型情報ライブラリ(TypeLib)内に定義された 1つの型情報を保持します。

...ようになりました。トップレベル定数 `WIN32OLE_TYPE` は後方互換のためのエイリアスとして残っていますが、Ruby 3.4 以降は非推奨
(deprecated)です(`Warning[:deprecated]` が有効なら参照時に警告が表示されます)。

### サンプルコード...

絞り込み条件を変える

WIN32OLE_TYPELIB (60127.0)

OLEオートメーションサーバの型情報ライブラリ(TypeLib)を操作するためのクラスです。

...うになりました。トップレベル定数 `WIN32OLE_TYPELIB` は後方互換のためのエイリアスとして残っていますが、Ruby 3.4 以降は非推奨
(deprecated)です(`Warning[:deprecated]` が有効なら参照時に警告が表示されます)。

### サンプルコード...

WIN32OLE_TYPELIB#ole_types -> [WIN32OLE_TYPE] (51967.0)

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

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

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

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

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

WIN32OLE#ole_obj_help -> WIN32OLE_TYPE | nil (51856.0)

[c:WIN32OLE_TYPE]オブジェクトを返します。

[c:WIN32OLE_TYPE]オブジェクトを返します。

[c:WIN32OLE_TYPE]オブジェクトは、WIN32OLEオブジェクトの文書情報と型情報を保持するオブジェクトです。

- **return** -- オブジェクトに関連する[c:WIN32OLE_TYPE]オブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。

```ruby
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
```

- **SEE** [c:WIN32OLE_TY...

WIN32OLE_VARIABLE#ole_type_detail -> [String] (51430.0)

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

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

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

```ruby
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
```

出力結果

```text
Unknown Type 31 [] pwcsName # => VT_LPWSTR はWIN32OLE::VAR...

WIN32OLE_PARAM#ole_type_detail -> [String] (51376.0)

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

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

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

```ruby
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の...

絞り込み条件を変える

WIN32OLE.ole_show_help(obj, helpcontext = nil) -> () (51196.0)

WIN32OLEオブジェクトのヘルプファイルを表示します。

WIN32OLEオブジェクトのヘルプファイルを表示します。

Windows標準のヘルプ表示コンポーネントのHHCtrl.OCXを利用して、オブジェクトに関連付けられたヘルプファイル(chmファイル)を表示します。

また、chmファイルのフルパス名を指定して表示させることも可能です。

- **param** `obj` -- [c:WIN32OLE_TYPE]オブジェクトまたは[c:WIN32OLE_METHOD]オブジェクト。直接ヘルプファイルのフルパス名を指定することも可能です。

- **param** `helpcontext` -- obj引数に[c:WIN32OLE_TYPE...

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (43039.0)

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

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

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

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

```ruby
tobj = WIN32OLE_TY...

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

WIN32OLE_TYPEオブジェクトを生成します。

WIN32OLE_TYPEオブジェクトを生成します。

- **param** `libname` -- 生成するTypeLibのレジストリ上のドキュメント文字列([m:WIN32OLE_TYPELIB#name])または
GUID([m:WIN32OLE_TYPELIB#guid])またはTLBファイル名を文字列で指定します。
- **param** `ole_class` -- 型情報を取り出す型の名前を指定します。
- **return** -- 指定されたTypeLIbに定義された型の情報を格納したWIN32OLE_TYPEオブジェクトを返します。
- ...

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

WIN32OLE_TYPELIBオブジェクトを生成します。

WIN32OLE_TYPELIBオブジェクトを生成します。

- **param** `libname` -- 生成するTypeLibのレジストリ上のドキュメント文字列([m:WIN32OLE_TYPELIB#name])または
GUID([m:WIN32OLE_TYPELIB#guid])またはTLBファイル名を文字列で指定します。
- **param** `mjv` -- 作成するTypeLibのメジャーバージョン番号をIntegerで指定します。
または整数部にメジャーバージョン、小数点数部にマイナーバージョンを指定したFloatで指...

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

TypeLibで定義されているすべての型情報を取得します。

TypeLibで定義されているすべての型情報を取得します。

- **param** `libname` -- 生成するTypeLibのレジストリ上のドキュメント文字列([m:WIN32OLE_TYPELIB#name])または
GUID([m:WIN32OLE_TYPELIB#guid])またはTLBファイル名を文字列で指定します。
- **return** -- TypeLibに格納されているすべての型を[c:WIN32OLE_TYPE]オブジェクトの配列として返します。
- **raise** `WIN32OLERuntimeError` -- 引数で指定...

絞り込み条件を変える

WIN32OLE_TYPELIB#ole_classes -> [WIN32OLE_TYPE] (42667.0)

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

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

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

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

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

WIN32OLE_TYPELIB.typelibs -> [WIN32OLE_TYPELIB] (42643.0)

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

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

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

```ruby
tlibs = WIN32OLE_TYPELIB.typelibs
```

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (42394.0)

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

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

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

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

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Libra...

WIN32OLE_TYPE#ole_methods -> [WIN32OLE_METHOD] (42376.0)

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

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

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

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

WIN32OLE_VARIABLE (42271.0)

OLEオートメーションの変数情報をRubyで参照するためのクラスです。

...うになりました。トップレベル定数 `WIN32OLE_VARIABLE` は後方互換のためのエイリアスとして残っていますが、Ruby 3.4 以降は非推奨
(deprecated)です(`Warning[:deprecated]` が有効なら参照時に警告が表示されます)。

### サンプルコード...

絞り込み条件を変える

WIN32OLE_METHOD (42253.0)

OLEオートメーションサーバが持つメソッドの情報を提供します。

...うになりました。トップレベル定数 `WIN32OLE_METHOD` は後方互換のためのエイリアスとして残っていますが、Ruby 3.4 以降は非推奨
(deprecated)です(`Warning[:deprecated]` が有効なら参照時に警告が表示されます)。

### サンプルコード

`...

WIN32OLE_TYPE#inspect -> String (42181.0)

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

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

- **return** -- "#<WIN32OLE_TYPE"と[m:WIN32OLE_TYPE#to_s]の結果を「:」で結合し、「>」で閉じた文字列を返します。

```ruby
x = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts x.inspect # => #<WIN32OLE_TYPE:Worksheet>
```

- **SEE** [m:WIN32OLE_TYPE#to_s]

WIN32OLE_PARAM (42163.0)

OLEオートメーションサーバが持つメソッドのパラメータ情報を提供します。

...ようになりました。トップレベル定数 `WIN32OLE_PARAM` は後方互換のためのエイリアスとして残っていますが、Ruby 3.4 以降は非推奨
(deprecated)です(`Warning[:deprecated]` が有効なら参照時に警告が表示されます)。

### サンプルコード...

WIN32OLE_TYPE#typekind -> Integer (42145.0)

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

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

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

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

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

- **SEE** [m:WI...

WIN32OLE_TYPE.progids -> [String] (42097.0)

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

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

- **return** -- システムに登録されているすべてのコンポーネントクラスのPROGIDを文字列配列で返します。

```ruby
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...

絞り込み条件を変える

WIN32OLE_TYPE#helpfile -> String | nil (42091.0)

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

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

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

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

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

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
...

WIN32OLE_TYPE#progid -> String | nil (42091.0)

selfのPROGIDを取得します。

selfのPROGIDを取得します。

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

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

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Applic...

WIN32OLE_TYPE.typelibs -> [String] (42043.0)

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

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

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

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

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

WIN32OLE_TYPE#guid -> String | nil (42037.0)

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

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

- **return** -- GUIDを文字列で返します。GUIDを持たない型の場合はnilを返します。

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Application')
puts tobj.guid # => {00024500-0000-0000-C000-000000000046}
```

GUIDは、COMのクラス識別子(CLSID)、インターフェイス識別子(IID)など多数の領域でWindows上のオブジェクト...

WIN32OLE_TYPE#helpcontext -> Integer | nil (42037.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPE#helpstring -> String | nil (42037.0)

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

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

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

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

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

WIN32OLE_TYPE#major_version -> Integer (42037.0)

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

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

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

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

WIN32OLE_TYPE#minor_version -> Integer (42037.0)

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

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

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

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

WIN32OLE_TYPE#name -> String (42037.0)

selfの型名を取得します。

selfの型名を取得します。

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

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

WIN32OLE_TYPE#src_type -> String | nil (42037.0)

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

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPE#to_s -> String (42037.0)

selfの型名を取得します。

selfの型名を取得します。

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

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

WIN32OLE_TYPE#visible? -> bool (42037.0)

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

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

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

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

WIN32OLE_TYPELIB#guid -> String (42019.0)

TypeLibのGUIDを取得します。

TypeLibのGUIDを取得します。

- **return** -- TypeLibのGUIDを文字列で返します。
- **raise** `WIN32OLERuntimeError` -- TypeLibの属性が読み取れない場合に通知します。

```ruby
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.guid # => '{00020813-0000-0000-C000-000000000046}'
```

WIN32OLE_TYPELIB#library_name -> String (42019.0)

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

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

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

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

WIN32OLE_TYPELIB#major_version -> Integer (42019.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPELIB#minor_version -> Integer (42019.0)

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

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

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

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

WIN32OLE_TYPELIB#name -> String (42019.0)

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

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

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

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

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

WIN32OLE_TYPELIB#path -> String (42019.0)

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

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

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

```ruby
tlib = WIN32OLE_TYPELIB.new('Microsoft Excel 14.0 Object Library')
puts tlib.path...

WIN32OLE_TYPELIB#to_s -> String (42019.0)

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

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

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

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

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

WIN32OLE_TYPELIB#version -> Float (42019.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_TYPELIB#visible? -> bool (42019.0)

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

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

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

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

```ruby
tlib = WIN32OLE_TYPELIB.new('Microso...

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

[c:WIN32OLE_TYPE]とメソッド名を指定してWIN32OLE_METHODのインスタンスを生成します。

[c:WIN32OLE_TYPE]とメソッド名を指定してWIN32OLE_METHODのインスタンスを生成します。

OLEオートメーションサーバの型情報とメソッド名からWIN32OLE_METHODのインスタンスを生成します。

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

- **param** `ole_type` -- [c:WIN32OLE_TYPE]のインスタンス。
- **param** `method` -- メソッド名を文字...

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

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

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

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

- **param** `ole_method` -- パラメータを取得する[c:WIN32OLE_METHOD]のインスタンス。
- **param** `index` -- パラメータの位置。最左端を1とします。
- **return** -- メソッドの指定位置のパラメータの情報を持つオブジェクトを返します。...

WIN32OLE_METHOD#params -> [WIN32OLE_PARAM] (33394.0)

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

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

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

- **return** -- [c:WIN32OLE_PARAM]の配列。無引数のメソッドであれば要素数0の配列を返します。

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

WIN32OLE_METHOD#dispid -> Integer (33145.0)

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

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

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

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

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.dispi...

絞り込み条件を変える

WIN32OLE_METHOD#helpcontext -> Integer | nil (33127.0)

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

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

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

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

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

WIN32OLE_METHODオブジェ...

WIN32OLE_METHOD#helpfile -> String | nil (33109.0)

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

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

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

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

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

WIN32OLE_METHOD#invoke_kind -> String (33091.0)

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

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

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

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

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

WIN32OLE_METHOD#return_type -> String (33091.0)

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

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

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

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

OLEオート...

WIN32OLE_PARAM#input? -> bool (33091.0)

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

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

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

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

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

```...

絞り込み条件を変える

WIN32OLE_PARAM#output? -> bool (33091.0)

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

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

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

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

- **return** -- メソッドの方向属性がoutまたはinoutならば真を返しま...

WIN32OLE_METHOD#event? -> bool (33073.0)

メソッドがイベントかどうかを取得します。

メソッドがイベントかどうかを取得します。

イベントとはこのサーバが実装しているメソッドではなく、クライアント側がサーバ側の通知を受けるために実装するメソッドです。

- **return** -- メソッドがイベントであれば真。

```ruby
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SheetActivate')
puts method.event? # => true
```

- **SEE** [c...

WIN32OLE_METHOD#return_type_detail -> [String] (33073.0)

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

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

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

```ruby
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"]
```

属性が付加されていない場合は、[m:WIN32OLE_METHOD#r...

WIN32OLE_PARAM#retval? -> bool (33073.0)

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

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

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

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

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

```ruby
tobj = WIN32OLE_TYP...

WIN32OLE_METHOD#event_interface -> String | nil (33055.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_METHOD#helpstring -> String | nil (33055.0)

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

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

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

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

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

WIN32OLE_METHOD#invkind -> Integer (33055.0)

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

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

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

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

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

WIN32OLE_METHOD#name -> String (33055.0)

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

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

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

```ruby
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 (33055.0)

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

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

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

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

```ruby
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_vtype -> Integer (33055.0)

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

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

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

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

絞り込み条件を変える

WIN32OLE_METHOD#size_opt_params -> Integer | nil (33055.0)

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

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

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

```ruby
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 (33055.0)

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

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

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

```ruby
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 (33055.0)

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

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

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

```ruby
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 (33055.0)

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

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

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

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

WIN32OLE_PARAM#default -> object | nil (33055.0)

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

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

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

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

```ruby
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#name -> String (33055.0)

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

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

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

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

WIN32OLE_PARAM#optional? -> bool (33055.0)

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

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

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

```ruby
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#to_s -> String (33055.0)

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

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

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

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

WIN32OLE_VARIABLE#variable_kind -> String (33055.0)

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

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

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

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

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

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

- **`PERINSTANCE`**:
インスタンス毎の変数。構造体やユー...

WIN32OLE_VARIABLE#varkind -> Integer (33055.0)

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

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

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

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

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

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

絞り込み条件を変える

WIN32OLE_VARIABLE#name -> String (33037.0)

変数名を取得します。

変数名を取得します。

- **return** -- 変数名を文字列で返します。

```ruby
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 (33037.0)

変数名を取得します。

変数名を取得します。

- **return** -- 変数名を文字列で返します。

```ruby
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 (33037.0)

変数の値を取得します。

変数の値を取得します。

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

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

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

WIN32OLE_VARIABLE#visible? -> bool (33037.0)

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

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

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

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