検索結果

IRB::OutputMethod#puts(*objs) -> object (54610.0)

• 2.6.0

• インスタンスメソッド

各 obj を self に出力し、それぞれの後に改行を出力します。

各 obj を self に出力し、それぞれの後に改行を出力します。

@param objs 任意のオブジェクトを指定します。

• IRB::OutputMethod

Object#initialize_copy(obj) -> object (27523.0)

• 2.6.0

• インスタンスメソッド

(拡張ライブラリによる) ユーザ定義クラスのオブジェクトコピーの初期化メソッド。

(拡張ライブラリによる) ユーザ定義クラスのオブジェクトコピーの初期化メソッド。

このメソッドは self を obj の内容で置き換えます。ただ
し、self のインスタンス変数や特異メソッドは変化しません。
Object#clone, Object#dupの内部で使われています。

initialize_copy は、Ruby インタプリタが知り得ない情報をコピーするた
めに使用(定義)されます。例えば C 言語でクラスを実装する場合、情報
をインスタンス変数に保持させない場合がありますが、そういった内部情
報を initialize_copy でコピーするよう定義しておくことで、du...

• Object

Object#public_send(name, *args) -> object (27346.0)

• 2.6.0

• インスタンスメソッド

オブジェクトの public メソッド name を args を引数にして呼び出し、メソッ ドの実行結果を返します。

オブジェクトの public メソッド name を args を引数にして呼び出し、メソッ
ドの実行結果を返します。

ブロック付きで呼ばれたときはブロックもそのまま引き渡します。

//emlist[][ruby]{
1.public_send(:+, 2) # => 3
//}

@param name 文字列かSymbol で指定するメソッド名です。

@param args 呼び出すメソッドに渡す引数です。

@raise ArgumentError name を指定しなかった場合に発生します。

@raise NoMethodError protected メソッドや priv...

• Object
• Symbol

Object#public_send(name, *args) { .... } -> object (27346.0)

• 2.6.0

• インスタンスメソッド

オブジェクトの public メソッド name を args を引数にして呼び出し、メソッ ドの実行結果を返します。

オブジェクトの public メソッド name を args を引数にして呼び出し、メソッ
ドの実行結果を返します。

ブロック付きで呼ばれたときはブロックもそのまま引き渡します。

//emlist[][ruby]{
1.public_send(:+, 2) # => 3
//}

@param name 文字列かSymbol で指定するメソッド名です。

@param args 呼び出すメソッドに渡す引数です。

@raise ArgumentError name を指定しなかった場合に発生します。

@raise NoMethodError protected メソッドや priv...

• Object
• Symbol

Object#initialize(*args, &block) -> object (27343.0)

• 2.6.0

• インスタンスメソッド

ユーザ定義クラスのオブジェクト初期化メソッド。

ユーザ定義クラスのオブジェクト初期化メソッド。

このメソッドは Class#new から新しく生成されたオブ
ジェクトの初期化のために呼び出されます。他の言語のコンストラクタに相当します。
デフォルトの動作ではなにもしません。

initialize には
Class#new に与えられた引数がそのまま渡されます。

サブクラスではこのメソッドを必要に応じて再定義されること
が期待されています。

initialize という名前のメソッドは自動的に private に設定され
ます。

@param args 初期化時の引数です。
@param block 初期化時のブロック引数です。必...

• Object

絞り込み条件を変える

Object#respond_to?(name, include_all = false) -> bool (27148.0)

• 2.6.0

• インスタンスメソッド

オブジェクトがメソッド name を持つとき真を返します。

オブジェクトがメソッド name を持つとき真を返します。

オブジェクトが メソッド name を持つというのは、
オブジェクトが メソッド name に応答できることをいいます。

Windows での Process.fork や GNU/Linux での File.lchmod の
ような NotImplementedError が発生する場合は false を返します。

※ NotImplementedError が発生する場合に false を返すのは
Rubyの組み込みライブラリや標準ライブラリなど、C言語で実装されているメソッドのみです。
Rubyで実装されたメソッドで N...

• NotImplementedError
• Object
• Symbol

Object#===(other) -> bool (27112.0)

• 2.6.0

• インスタンスメソッド

case 式で使用されるメソッドです。d:spec/control#case も参照してください。

case 式で使用されるメソッドです。d:spec/control#case も参照してください。

このメソッドは case 式での振る舞いを考慮して、
各クラスの性質に合わせて再定義すべきです。

デフォルトでは内部で Object#== を呼び出します。

when 節の式をレシーバーとして === を呼び出すことに注意してください。

また Enumerable#grep でも使用されます。

@param other 比較するオブジェクトです。

//emlist[][ruby]{
age = 12
# (0..2).===(12), (3..6).===(12), ... が実行...

• Object

Object#tap {|x| ... } -> self (27094.0)

• 2.6.0

• インスタンスメソッド

self を引数としてブロックを評価し、self を返します。

self を引数としてブロックを評価し、self を返します。

メソッドチェインの途中で直ちに操作結果を表示するために
メソッドチェインに "入り込む" ことが、このメソッドの主目的です。

//emlist[][ruby]{
(1..10) .tap {|x| puts "original: #{x}" }
.to_a .tap {|x| puts "array: #{x}" }
.select {|x| x.even? } .tap {|x| puts "evens: #{x}" }
.map ...

• Object

Object#taint -> self (27076.0)

• 2.6.0

• インスタンスメソッド

このメソッドは Ruby 2.7 から deprecated で、Ruby 3.2 で削除予定です。

このメソッドは Ruby 2.7 から deprecated で、Ruby 3.2 で削除予定です。

オブジェクトの「汚染マーク」をセットします。

環境変数（ENVで得られる文字列）など一部のオブジェクトは最初から汚染されています。
オブジェクトの汚染に関してはspec/safelevelを参照してください。

//emlist[][ruby]{
$SAFE = 1

some = "puts '@&%&(#!'"
p some.tainted? #=> false
eval(some) #=> @&%&(#!

some.taint
p some.tainted? #=> true
e...

• ENV
• Object
• spec/safelevel

Object#to_s -> String (27058.0)

• 2.6.0

• インスタンスメソッド

オブジェクトの文字列表現を返します。

オブジェクトの文字列表現を返します。

Kernel.#print や Kernel.#sprintf は文字列以外の
オブジェクトが引数に渡された場合このメソッドを使って文字列に変換し
ます。

//emlist[][ruby]{
class Foo
def initialize num
@num = num
end
end
it = Foo.new(40)

puts it #=> #<Foo:0x2b69110>

class Foo
def to_s
"Class:Foo Number:#{@num}"
end
end

puts it #=> Cla...

• Object

絞り込み条件を変える

Object#enum_for(method = :each, *args) -> Enumerator (27022.0)

• 2.6.0

• インスタンスメソッド

Enumerator.new(self, method, *args) を返します。

Enumerator.new(self, method, *args) を返します。

ブロックを指定した場合は Enumerator#size がブロックの評価結果を返
します。ブロックパラメータは引数 args です。


@param method メソッド名の文字列かシンボルです。
@param args 呼び出すメソッドに渡される引数です。

//emlist[][ruby]{
str = "xyz"

enum = str.enum_for(:each_byte)
p(a = enum.map{|b| '%02x' % b }) #=> ["78", "79", "7a"]

#...

• Enumerator
• Object

Object#enum_for(method = :each, *args) {|*args| ... } -> Enumerator (27022.0)

• 2.6.0

• インスタンスメソッド

Enumerator.new(self, method, *args) を返します。

Enumerator.new(self, method, *args) を返します。

ブロックを指定した場合は Enumerator#size がブロックの評価結果を返
します。ブロックパラメータは引数 args です。


@param method メソッド名の文字列かシンボルです。
@param args 呼び出すメソッドに渡される引数です。

//emlist[][ruby]{
str = "xyz"

enum = str.enum_for(:each_byte)
p(a = enum.map{|b| '%02x' % b }) #=> ["78", "79", "7a"]

#...

• Enumerator
• Object

Object#to_enum(method = :each, *args) -> Enumerator (27022.0)

• 2.6.0

• インスタンスメソッド

Enumerator.new(self, method, *args) を返します。

Enumerator.new(self, method, *args) を返します。

ブロックを指定した場合は Enumerator#size がブロックの評価結果を返
します。ブロックパラメータは引数 args です。


@param method メソッド名の文字列かシンボルです。
@param args 呼び出すメソッドに渡される引数です。

//emlist[][ruby]{
str = "xyz"

enum = str.enum_for(:each_byte)
p(a = enum.map{|b| '%02x' % b }) #=> ["78", "79", "7a"]

#...

• Enumerator
• Object

Object#to_enum(method = :each, *args) {|*args| ... } -> Enumerator (27022.0)

• 2.6.0

• インスタンスメソッド

Enumerator.new(self, method, *args) を返します。

Enumerator.new(self, method, *args) を返します。

ブロックを指定した場合は Enumerator#size がブロックの評価結果を返
します。ブロックパラメータは引数 args です。


@param method メソッド名の文字列かシンボルです。
@param args 呼び出すメソッドに渡される引数です。

//emlist[][ruby]{
str = "xyz"

enum = str.enum_for(:each_byte)
p(a = enum.map{|b| '%02x' % b }) #=> ["78", "79", "7a"]

#...

• Enumerator
• Object

Enumerator#with_object(obj) {|(*args), memo_obj| ... } -> object (18667.0)

• 2.6.0

• インスタンスメソッド

繰り返しの各要素に obj を添えてブロックを繰り返し、obj を返り値として返します。

繰り返しの各要素に obj を添えてブロックを繰り返し、obj を返り値として返します。

obj には任意のオブジェクトを渡すことができます。

ブロックが渡されなかった場合は、上で説明した繰り返しを実行し、
最後に obj を返す Enumerator を返します。

//emlist[例][ruby]{
# 0,1,2 と呼びだす enumeratorを作る
to_three = Enumerator.new do |y|
3.times do |x|
y << x
end
end

to_three_with_string = to_three.with_object...

• Enumerator

絞り込み条件を変える

JSON::State#object_nl -> String (18415.0)

• 2.6.0

• インスタンスメソッド

JSON 形式の文字列中に現れる JavaScript のオブジェクトの行末に挿入する文字列を返します。

JSON 形式の文字列中に現れる JavaScript のオブジェクトの行末に挿入する文字列を返します。

//emlist[例][ruby]{
require "json"

json_state = JSON::State.new(object_nl: "")
json_state.object_nl # => ""
puts JSON.generate([1, 2, { name: "tanaka", age: 19 }], json_state)
# => [1,2,{"name":"tanaka","age":19}]

json_state = JSON:...

• JSON::State

JSON::State#object_nl=(string) (18415.0)

• 2.6.0

• インスタンスメソッド

JSON 形式の文字列中に現れる JavaScript のオブジェクトの行末に挿入する文字列をセットします。

JSON 形式の文字列中に現れる JavaScript のオブジェクトの行末に挿入する文字列をセットします。

@param string JSON 形式の文字列中に現れる JavaScript のオブジェクトの行末に挿入する文字列を指定します。

//emlist[例][ruby]{
require "json"

json_state = JSON::State.new(object_nl: "")
json_state.object_nl # => ""
puts JSON.generate([1, 2, { name: "tanaka", age: 19 }]...

• JSON::State

Enumerator#with_object(obj) -> Enumerator (18367.0)

• 2.6.0

• インスタンスメソッド

繰り返しの各要素に obj を添えてブロックを繰り返し、obj を返り値として返します。

繰り返しの各要素に obj を添えてブロックを繰り返し、obj を返り値として返します。

obj には任意のオブジェクトを渡すことができます。

ブロックが渡されなかった場合は、上で説明した繰り返しを実行し、
最後に obj を返す Enumerator を返します。

//emlist[例][ruby]{
# 0,1,2 と呼びだす enumeratorを作る
to_three = Enumerator.new do |y|
3.times do |x|
y << x
end
end

to_three_with_string = to_three.with_object...

• Enumerator

BasicObject#singleton_method_added(name) -> object (9325.0)

• 2.6.0

• インスタンスメソッド

特異メソッドが追加された時にインタプリタから呼び出されます。

特異メソッドが追加された時にインタプリタから呼び出されます。

通常のメソッドの追加に対するフックには
Module#method_addedを使います。

@param name 追加されたメソッド名が Symbol で渡されます。

//emlist[例][ruby]{
class Foo
def singleton_method_added(name)
puts "singleton method \"#{name}\" was added"
end
end

obj = Foo.new
def obj.foo
end

#=> singleton method "fo...

• BasicObject
• Symbol

BasicObject#singleton_method_removed(name) -> object (9325.0)

• 2.6.0

• インスタンスメソッド

特異メソッドが Module#remove_method に より削除された時にインタプリタから呼び出されます。

特異メソッドが Module#remove_method に
より削除された時にインタプリタから呼び出されます。

通常のメソッドの削除に対するフックには
Module#method_removedを使います。

@param name 削除されたメソッド名が Symbol で渡されます。

//emlist[例][ruby]{
class Foo
def singleton_method_removed(name)
puts "singleton method \"#{name}\" was removed"
end
end

obj = Foo.new
def obj.f...

• BasicObject
• Symbol

絞り込み条件を変える

BasicObject#singleton_method_undefined(name) -> object (9325.0)

• 2.6.0

• インスタンスメソッド

特異メソッドが Module#undef_method または undef により未定義にされた時にインタプリタから呼び出されます。

特異メソッドが Module#undef_method または
undef により未定義にされた時にインタプリタから呼び出されます。

通常のメソッドの未定義に対するフックには
Module#method_undefined を使います。

@param name 未定義にされたメソッド名が Symbol で渡されます。

//emlist[例][ruby]{
class Foo
def singleton_method_undefined(name)
puts "singleton method \"#{name}\" was undefined"
end
end

obj...

• BasicObject
• Symbol

BasicObject#! -> bool (9058.0)

• 2.6.0

• インスタンスメソッド

オブジェクトを真偽値として評価し、その論理否定を返します。

オブジェクトを真偽値として評価し、その論理否定を返します。

このメソッドは self が nil または false であれば真を、さもなくば偽を返します。
主に論理式の評価に伴って副作用を引き起こすことを目的に
再定義するものと想定されています。

このメソッドを再定義しても Ruby の制御式において nil や false 以外が偽として
扱われることはありません。

@return オブジェクトが偽であれば真、さもなくば偽

//emlist[例][ruby]{
class NegationRecorder < BasicObject
def initialize
@co...

• BasicObject

BasicObject#!=(other) -> bool (9022.0)

• 2.6.0

• インスタンスメソッド

オブジェクトが other と等しくないことを判定します。

オブジェクトが other と等しくないことを判定します。

デフォルトでは self == other を評価した後に結果を論理否定して返します。
このため、サブクラスで BasicObject#== を再定義しても != とは自動的に整合性が
とれるようになっています。

ただし、 BasicObject#!= 自身や BasicObject#! を再定義した際には、ユーザーの責任で
整合性を保たなくてはなりません。

このメソッドは主に論理式の評価に伴って副作用を引き起こすことを目的に
再定義するものと想定されています。

@param other 比較対象となるオブジェクト
@see ...

• BasicObject

Enumerator#next -> object (397.0)

• 2.6.0

• インスタンスメソッド

「次」のオブジェクトを返します。

「次」のオブジェクトを返します。

現在までの列挙状態に応じて「次」のオブジェクトを返し、列挙状態を1つ分進めます。
列挙が既に最後へ到達している場合は、
StopIteration 例外を発生します。このとき列挙状態は変化しません。
つまりもう一度 next を呼ぶと再び例外が発生します。

next メソッドによる外部列挙の状態は他のイテレータメソッドによる
内部列挙には影響を与えません。
ただし、 IO#each_line のようにおおもとの列挙メカニズムが副作用を
伴っている場合には影響があり得ます。

@raise StopIteration 列挙状態が既に最後へ到達しているとき
@...

• Enumerator
• StopIteration

WIN32OLE_PARAM#default -> object | nil (361.0)

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

絞り込み条件を変える

Thread::Queue#deq(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = Queue.new

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].each { |r|
q.push(r)
}

t...

• Thread::Queue
• ThreadError

Thread::Queue#pop(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = Queue.new

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].each { |r|
q.push(r)
}

t...

• Thread::Queue
• ThreadError

Thread::Queue#shift(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = Queue.new

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].each { |r|
q.push(r)
}

t...

• Thread::Queue
• ThreadError

Thread::SizedQueue#deq(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。 キューに push しようと待っているスレッドがあれば、実行を再開させます。

キューからひとつ値を取り出します。
キューに push しようと待っているスレッドがあれば、実行を再開させます。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = SizedQueue.new(4)

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].eac...

• Thread::SizedQueue
• ThreadError

Thread::SizedQueue#pop(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。 キューに push しようと待っているスレッドがあれば、実行を再開させます。

キューからひとつ値を取り出します。
キューに push しようと待っているスレッドがあれば、実行を再開させます。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = SizedQueue.new(4)

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].eac...

• Thread::SizedQueue
• ThreadError

絞り込み条件を変える

Thread::SizedQueue#shift(non_block = false) -> object (349.0)

• 2.6.0

• インスタンスメソッド

キューからひとつ値を取り出します。 キューに push しようと待っているスレッドがあれば、実行を再開させます。

キューからひとつ値を取り出します。
キューに push しようと待っているスレッドがあれば、実行を再開させます。

@param non_block true を与えると、キューが空の時に例外 ThreadError が発生します。

//emlist[例][ruby]{
require 'thread'

q = SizedQueue.new(4)

th1 = Thread.start do
while resource = q.pop
puts resource
end
end

[:resource1, :resource2, :resource3, nil].eac...

• Thread::SizedQueue
• ThreadError

Enumerable#cycle(n=nil) {|obj| ... } -> object | nil (343.0)

• 2.6.0

• インスタンスメソッド

Enumerable オブジェクトの各要素を n 回 or 無限回(n=nil)繰り返し ブロックを呼びだします。

Enumerable オブジェクトの各要素を n 回 or 無限回(n=nil)繰り返し
ブロックを呼びだします。

n に 0 もしくは負の値を渡した場合は何もしません。
繰り返しが最後まで終了した場合(つまりbreakなどで中断しなかった場合)
は nil を返します。
このメソッドは内部の配列に各要素を保存しておくため、
一度 Enumerable の終端に到達した後に自分自身を変更しても
このメソッドの動作に影響を与えません。

//emlist[例][ruby]{
a = ["a", "b", "c"]
a.cycle {|x| puts x } # print, a, b, c,...

• Enumerable
• Enumerator

WIN32OLE#_getproperty(dispid, args, types) -> object (343.0)

• 2.6.0

• インスタンスメソッド

DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。

DISPIDとパラメータの型を指定してオブジェクトのプロパティを参照します。

アクセスするプロパティのインターフェイスを事前に知っている場合に、
DISPIDとパラメータの型を指定してプロパティを参照します。

@param dispid プロパティのDISPID（メソッドを一意に特定する数値）を指定
します。

@param args プロパティが引数を取る場合に配列で指定します。引数の順序は
最左端の引数のインデックスを0とします。引数が不要な場合は空
配列を指定します。

@param types プロパティが...

• WIN32OLE
• WIN32OLE::VARIANT

WIN32OLE_VARIABLE#value -> object | nil (343.0)

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

Array#fetch(nth) -> object (331.0)

• 2.6.0

• インスタンスメソッド

nth 番目の要素を返します。

nth 番目の要素を返します。

Array#[] (nth) とは nth 番目の要素が存在しない場合の振舞いが異
なります。最初の形式では、例外 IndexError が発生します。
二番目の形式では、引数 ifnone を返します。
三番目の形式では、ブロックを評価した結果を返します。

@param nth 取得したい要素のインデックスを整数で指定します。
整数以外のオブジェクトを指定した場合は to_int メソッドによる
暗黙の型変換を試みます。

@param ifnone 要素が存在しなかった場合に返すべき値を指定します。

@ra...

• Array
• IndexError

絞り込み条件を変える

Array#fetch(nth) {|nth| ... } -> object (331.0)

• 2.6.0

• インスタンスメソッド

nth 番目の要素を返します。

nth 番目の要素を返します。

Array#[] (nth) とは nth 番目の要素が存在しない場合の振舞いが異
なります。最初の形式では、例外 IndexError が発生します。
二番目の形式では、引数 ifnone を返します。
三番目の形式では、ブロックを評価した結果を返します。

@param nth 取得したい要素のインデックスを整数で指定します。
整数以外のオブジェクトを指定した場合は to_int メソッドによる
暗黙の型変換を試みます。

@param ifnone 要素が存在しなかった場合に返すべき値を指定します。

@ra...

• Array
• IndexError

Array#fetch(nth, ifnone) -> object (331.0)

• 2.6.0

• インスタンスメソッド

nth 番目の要素を返します。

nth 番目の要素を返します。

Array#[] (nth) とは nth 番目の要素が存在しない場合の振舞いが異
なります。最初の形式では、例外 IndexError が発生します。
二番目の形式では、引数 ifnone を返します。
三番目の形式では、ブロックを評価した結果を返します。

@param nth 取得したい要素のインデックスを整数で指定します。
整数以外のオブジェクトを指定した場合は to_int メソッドによる
暗黙の型変換を試みます。

@param ifnone 要素が存在しなかった場合に返すべき値を指定します。

@ra...

• Array
• IndexError

Net::POPMail#all(io) -> object (331.0)

• 2.6.0

• インスタンスメソッド

メールを受信します。

メールを受信します。

引数もブロックも与えられなかった場合にはメール
の内容を文字列で返します。

ブロックが渡されたときは、メールの内容を
少しずつ読み込み、読みこんだ文字列を
引数としてブロックを呼びだします。

ブロックなしで、オブジェクトを
引数として渡すとそのオブジェクトに
メールの内容を << メソッドで順次書き込みます。
通常 IO オブジェクトを渡します。
この場合引数として渡したオブジェクトを返します。

pop, all, mail はすべて同じ効果ですが、
all と mail は obsolete です。


使用例:

require 'net/pop'

...

• IO
• Net::POPMail

Net::POPMail#mail(io) -> object (331.0)

• 2.6.0

• インスタンスメソッド

メールを受信します。

メールを受信します。

引数もブロックも与えられなかった場合にはメール
の内容を文字列で返します。

ブロックが渡されたときは、メールの内容を
少しずつ読み込み、読みこんだ文字列を
引数としてブロックを呼びだします。

ブロックなしで、オブジェクトを
引数として渡すとそのオブジェクトに
メールの内容を << メソッドで順次書き込みます。
通常 IO オブジェクトを渡します。
この場合引数として渡したオブジェクトを返します。

pop, all, mail はすべて同じ効果ですが、
all と mail は obsolete です。


使用例:

require 'net/pop'

...

• IO
• Net::POPMail

Net::POPMail#pop(io) -> object (331.0)

• 2.6.0

• インスタンスメソッド

メールを受信します。

メールを受信します。

引数もブロックも与えられなかった場合にはメール
の内容を文字列で返します。

ブロックが渡されたときは、メールの内容を
少しずつ読み込み、読みこんだ文字列を
引数としてブロックを呼びだします。

ブロックなしで、オブジェクトを
引数として渡すとそのオブジェクトに
メールの内容を << メソッドで順次書き込みます。
通常 IO オブジェクトを渡します。
この場合引数として渡したオブジェクトを返します。

pop, all, mail はすべて同じ効果ですが、
all と mail は obsolete です。


使用例:

require 'net/pop'

...

• IO
• Net::POPMail

絞り込み条件を変える

Addrinfo#connect_from(host, port) {|sock| ... } -> object (325.0)

• 2.6.0

• インスタンスメソッド

引数で指定されたアドレスから 自身のアドレスへソケットを接続します。

引数で指定されたアドレスから
自身のアドレスへソケットを接続します。

接続元のアドレスは Addrinfo#family_addrinfo により生成された
ものが用いられます。

ブロックが渡されたときにはそのブロックに接続済み Socket
オブジェクトが渡されます。ブロックの返り値がメソッドの返り値となります。
ブロックを省略した場合は、接続済みSocket
オブジェクトが返されます。

引数で指定したアドレスはソケット接続のローカル側のアドレスになります。

require 'socket'

Addrinfo.tcp("www.ruby-lang.org", 80).co...

• Addrinfo
• Socket

Enumerable#max_by {|item| ... } -> object | nil (325.0)

• 2.6.0

• インスタンスメソッド

各要素を順番にブロックに渡して実行し、 その評価結果を <=> で比較して、 最大であった値に対応する元の要素、もしくは最大の n 要素が降順で入った配列を返します。

各要素を順番にブロックに渡して実行し、
その評価結果を <=> で比較して、
最大であった値に対応する元の要素、もしくは最大の n 要素が降順で入った配列を返します。

引数を指定しない形式では要素が存在しなければ nil を返します。
引数を指定する形式では、空の配列を返します。
該当する要素が複数存在する場合、どの要素を返すかは不定です。

Enumerable#max と Enumerable#max_by の
違いは Enumerable#sort と Enumerable#sort_by の違いと同じです。

ブロックを省略した場合は Enumerator を返します。

@par...

• Enumerable
• Enumerator

Regexp#match(str, pos = 0) {|m| ... } -> object | nil (325.0)

• 2.6.0

• インスタンスメソッド

指定された文字列 str に対して位置 pos から自身が表す正規表現によるマッ チングを行います。マッチした場合には結果を MatchData オブジェクトで返し ます。 マッチしなかった場合 nil を返します。

指定された文字列 str に対して位置 pos から自身が表す正規表現によるマッ
チングを行います。マッチした場合には結果を MatchData オブジェクトで返し
ます。
マッチしなかった場合 nil を返します。

省略可能な第二引数 pos を指定すると、マッチの開始位置を pos から行
うよう制御できます(pos のデフォルト値は 0)。

//emlist[例][ruby]{
p(/(.).(.)/.match("foobar", 3).captures) # => ["b", "r"]
p(/(.).(.)/.match("foobar", -3).captures) #...

• NoMethodError
• Regexp

Shell::Filter#|(filter) -> object (325.0)

• 2.6.0

• インスタンスメソッド

パイプ結合を filter に対して行います。

パイプ結合を filter に対して行います。

@param filter Shell::Filter オブジェクトを指定します。

@return filter を返します。

使用例
require 'shell'
Shell.def_system_command("tail")
Shell.def_system_command("head")
Shell.def_system_command("wc")
sh = Shell.new
sh.transact {
i = 1
while i <= (cat("/etc/passwd") | wc(...

• Shell::Filter

Thread#[](name) -> object | nil (325.0)

• 2.6.0

• インスタンスメソッド

name に対応したスレッドに固有のデータを取り出します。 name に対応するスレッド固有データがなければ nil を返し ます。

name に対応したスレッドに固有のデータを取り出します。
name に対応するスレッド固有データがなければ nil を返し
ます。

@param name スレッド固有データのキーを文字列か Symbol で指定します。

//emlist[例][ruby]{
[
Thread.new { Thread.current["name"] = "A" },
Thread.new { Thread.current[:name] = "B" },
Thread.new { Thread.current["name"] = "C" }
].each do |th|
th.join...

• Symbol
• Thread

絞り込み条件を変える

Zlib::GzipWriter#putc(ch) -> object (325.0)

• 2.6.0

• インスタンスメソッド

文字 ch を自身に出力します。

文字 ch を自身に出力します。

ch が数値なら 0 〜 255 の範囲の対応する文字を出力します。
ch が文字列なら、その先頭 1byte を出力します。
どちらでもない場合は、ch.to_int で整数に変換を試みます。

@param ch 出力する文字を数値または文字列で指定します。

@return ch を返します。

require 'zlib'

filename='hoge1.gz'
fw = File.open(filename, "w")
Zlib::GzipWriter.wrap(fw, Zlib::BEST_COMPRESSION){|gz|
...

• Zlib::GzipWriter

Regexp#===(string) -> bool (76.0)

• 2.6.0

• インスタンスメソッド

文字列 string との正規表現マッチを行います。 マッチした場合は真を返します。

文字列 string との正規表現マッチを行います。
マッチした場合は真を返します。

string が文字列でもシンボルでもない場合には false を返します。

このメソッドは主にcase文での比較に用いられます。

@param string マッチ対象文字列

//emlist[例][ruby]{
a = "HELLO"
case a
when /\A[a-z]*\z/; puts "Lower case"
when /\A[A-Z]*\z/; puts "Upper case"
else; puts "Mixed case"
end
# => Upper ...

• Regexp

ARGF.class#each(rs = $/) -> Enumerator (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each(rs = $/) { |line| ... } -> self (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each(rs = $/, limit) -> Enumerator (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

絞り込み条件を変える

ARGF.class#each(rs = $/, limit) { |line| ... } -> self (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each_line(rs = $/) -> Enumerator (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each_line(rs = $/) { |line| ... } -> self (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each_line(rs = $/, limit) -> Enumerator (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

ARGF.class#each_line(rs = $/, limit) { |line| ... } -> self (58.0)

• 2.6.0

• インスタンスメソッド

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら
れたブロックを実行します。

ブロックが与えられなかった場合は、Enumerator オブジェクトを生成し
て返します。

このメソッドはスクリプトに指定した引数(Object::ARGV を参照) をファ
イル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオ
ブジェクトです。そのため、最初のファイルを最後まで読んだ後は次のファイ
ルの内容を返します。現在の行についてファイル名や行数を得るには
ARGF.class#filename と ARGF.class#lineno を使用します。

...

• ARGF.class
• Enumerator

絞り込み条件を変える

WIN32OLE_TYPE#ole_typelib -> WIN32OLE_TYPELIB | nil (58.0)

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

WIN32OLE_TYPELIB#name -> String (58.0)

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

WIN32OLE_TYPELIB#to_s -> String (58.0)

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

Enumerable#cycle(n=nil) -> Enumerator (43.0)

• 2.6.0

• インスタンスメソッド

Enumerable オブジェクトの各要素を n 回 or 無限回(n=nil)繰り返し ブロックを呼びだします。

Enumerable オブジェクトの各要素を n 回 or 無限回(n=nil)繰り返し
ブロックを呼びだします。

n に 0 もしくは負の値を渡した場合は何もしません。
繰り返しが最後まで終了した場合(つまりbreakなどで中断しなかった場合)
は nil を返します。
このメソッドは内部の配列に各要素を保存しておくため、
一度 Enumerable の終端に到達した後に自分自身を変更しても
このメソッドの動作に影響を与えません。

//emlist[例][ruby]{
a = ["a", "b", "c"]
a.cycle {|x| puts x } # print, a, b, c,...

• Enumerable
• Enumerator

Kernel#xmp(exps, bind = nil) -> XMP (40.0)

• 2.6.0

• インスタンスメソッド

引数 exps で指定されたRuby のソースコードとその実行結果を、標準出力に行 ごとに交互に表示します。

引数 exps で指定されたRuby のソースコードとその実行結果を、標準出力に行
ごとに交互に表示します。

@param exps 評価するRuby のソースコードを文字列で指定します。

@param bind Binding オブジェクトを指定します。省略した場合は、最
後に実行した XMP#puts、Kernel#xmp の
Binding を使用します。まだ何も実行していない場合は
Object::TOPLEVEL_BINDING を使用します。

• Binding
• Kernel

絞り込み条件を変える

WIN32OLE#ole_typelib -> WIN32OLE_TYPELIB (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE
• WIN32OLE_TYPELIB

WIN32OLE_METHOD#dispid -> Integer (40.0)

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

WIN32OLE_METHOD#event? -> bool (40.0)

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

WIN32OLE_METHOD#event_interface -> String | nil (40.0)

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

WIN32OLE_METHOD#helpcontext -> Integer | nil (40.0)

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

絞り込み条件を変える

WIN32OLE_METHOD#helpfile -> String | nil (40.0)

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

WIN32OLE_METHOD#invkind -> Integer (40.0)

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

WIN32OLE_METHOD#invoke_kind -> String (40.0)

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

WIN32OLE_METHOD#name -> String (40.0)

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

WIN32OLE_METHOD#offset_vtbl -> Integer (40.0)

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

絞り込み条件を変える

WIN32OLE_METHOD#return_type -> String (40.0)

• 2.6.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::VARIANT
• WIN32OLE_METHOD

WIN32OLE_METHOD#return_vtype -> Integer (40.0)

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

WIN32OLE_METHOD#size_opt_params -> Integer | nil (40.0)

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

WIN32OLE_METHOD#size_params -> Integer | nil (40.0)

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

WIN32OLE_METHOD#to_s -> String (40.0)

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

絞り込み条件を変える

WIN32OLE_METHOD#visible? -> bool (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE_METHOD

WIN32OLE_PARAM#input? -> bool (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

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

tobj = WIN32OLE...

• WIN32OLE_PARAM

WIN32OLE_PARAM#name -> String (40.0)

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

WIN32OLE_PARAM#ole_type -> String (40.0)

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

WIN32OLE_PARAM#optional? -> bool (40.0)

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

絞り込み条件を変える

WIN32OLE_PARAM#to_s -> String (40.0)

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

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

tobj = ...

• WIN32OLE_TYPE

WIN32OLE_TYPE#guid -> String | nil (40.0)

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

WIN32OLE_TYPE#helpcontext -> Integer | nil (40.0)

• 2.6.0

• インスタンスメソッド

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

この型に関連するヘルプファイルのトピック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 (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

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

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

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#inspect -> String (40.0)

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

WIN32OLE_TYPE#variables -> [WIN32OLE_VARIABLE] (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE_TYPE
• WIN32OLE_VARIABLE

WIN32OLE_TYPELIB#guid -> String (40.0)

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

WIN32OLE_TYPELIB#major_version -> Integer (40.0)

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

WIN32OLE_TYPELIB#minor_version -> Integer (40.0)

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

絞り込み条件を変える

WIN32OLE_TYPELIB#path -> String (40.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE_TYPELIB

WIN32OLE_TYPELIB#version -> Float (40.0)

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

WIN32OLE_TYPELIB#visible? -> bool (40.0)

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

WIN32OLE_VARIABLE#name -> String (40.0)

• 2.6.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 (40.0)

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

絞り込み条件を変える

WIN32OLE_VARIABLE#to_s -> String (40.0)

• 2.6.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#variable_kind -> String (40.0)

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

WIN32OLE_VARIABLE#varkind -> Integer (40.0)

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

WIN32OLE_VARIABLE#visible? -> bool (40.0)

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

Net::POPMail#all -> String (31.0)

• 2.6.0

• インスタンスメソッド

メールを受信します。

メールを受信します。

引数もブロックも与えられなかった場合にはメール
の内容を文字列で返します。

ブロックが渡されたときは、メールの内容を
少しずつ読み込み、読みこんだ文字列を
引数としてブロックを呼びだします。

ブロックなしで、オブジェクトを
引数として渡すとそのオブジェクトに
メールの内容を << メソッドで順次書き込みます。
通常 IO オブジェクトを渡します。
この場合引数として渡したオブジェクトを返します。

pop, all, mail はすべて同じ効果ですが、
all と mail は obsolete です。


使用例:

require 'net/pop'

...

• IO
• Net::POPMail

絞り込み条件を変える