検索結果

Net::FTP#help(arg = nil) -> String (54373.0)

• 2.1.0

• インスタンスメソッド

サーバからの help 情報を返します。

サーバからの help 情報を返します。

@param arg HELP コマンドのパラメータを指定します。

@raise Net::FTPTempError 応答コードが 4yz のときに発生します。
@raise Net::FTPPermError 応答コードが 5yz のときに発生します。
@raise Net::FTPProtoError 応答コードが RFC 的に正しくない場合に発生します。

• Net::FTP

Kernel#help -> () (54325.0)

• 2.1.0

• インスタンスメソッド

ヘルプメッセージを表示します。

ヘルプメッセージを表示します。


ruby -run -e help [COMMAND]

• Kernel

OptionParser#help -> String (54325.0)

• 2.1.0

• インスタンスメソッド

サマリの文字列を返します。

サマリの文字列を返します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

puts opts.help

# => Usage: example.rb [options]
# -v...

• OptionParser

WIN32OLE_TYPE#helpfile -> String | nil (18358.0)

• 2.1.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_METHOD#helpcontext -> Integer | nil (18340.0)

• 2.1.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 (18340.0)

• 2.1.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#ole_obj_help -> WIN32OLE_TYPE | nil (18325.0)

• 2.1.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
• WIN32OLE_TYPE

Gem::Command#show_help -> () (18307.0)

• 2.1.0

• インスタンスメソッド

コマンドの使用方法を表示します。

コマンドの使用方法を表示します。

• Gem::Command

WIN32OLE_METHOD#helpstring -> String | nil (18304.0)

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

WIN32OLE_TYPE#helpcontext -> Integer | nil (18304.0)

• 2.1.0

• インスタンスメソッド

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

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

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

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

• WIN32OLE_TYPE

絞り込み条件を変える

WIN32OLE_TYPE#helpstring -> String | nil (18304.0)

• 2.1.0

• インスタンスメソッド

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

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

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

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

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

• WIN32OLE_TYPE

WIN32OLE#ole_method_help(method) -> WIN32OLE_METHOD (9325.0)

• 2.1.0

• インスタンスメソッド

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。

OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。

@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発...

• WIN32OLE
• WIN32OLE_METHOD

IRB::ExtendCommand::Help#execute(*names) -> nil (9040.0)

• 2.1.0

• インスタンスメソッド

RI から Ruby のドキュメントを参照します。

RI から Ruby のドキュメントを参照します。

irb(main):001:0> help String#match
...

@param names 参照したいクラス名やメソッド名などを文字列で指定します。

names を指定しなかった場合は、RI を対話的なモードで起動します。メソッド
名などを入力する事でドキュメントの検索が行えます。入力のタブ補完をする
事ができます。また、空行を入力する事で irb のプロンプトに戻る事ができま
す。

irb(main):001:0> help

Enter the method name you want to look...

• IRB::ExtendCommand::Help

OptionParser#to_s -> String (9025.0)

• 2.1.0

• インスタンスメソッド

サマリの文字列を返します。

サマリの文字列を返します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

puts opts.help

# => Usage: example.rb [options]
# -v...

• OptionParser

WIN32OLE#ole_type -> WIN32OLE_TYPE | nil (9025.0)

• 2.1.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
• WIN32OLE_TYPE

絞り込み条件を変える

OptionParser#on_tail(*arg, &block) -> self (94.0)

• 2.1.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

--version や --help の説明をサマリの最後に表示したい時に便利です。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tai...

• OptionParser

OptionParser#on_head(*arg, &block) -> self (58.0)

• 2.1.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

puts opts.help

# => ...

• OptionParser

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (58.0)

• 2.1.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (58.0)

• 2.1.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

OptionParser#summary_indent -> String (58.0)

• 2.1.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で返します。

サマリを表示する時のインデントを文字列で返します。

@return サマリを表示する時のインデントを文字列で返します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_indent # => " "
opts.summarize
# => [" -i,...

• OptionParser

絞り込み条件を変える

OptionParser#summary_indent=(indent) (58.0)

• 2.1.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で指定します。

サマリを表示する時のインデントを文字列で指定します。

@param indent サマリを表示する時に使われるインデントを文字列で指定します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_indent # => " "
opts.summarize
# ...

• OptionParser

OptionParser#summary_width -> Integer (58.0)

• 2.1.0

• インスタンスメソッド

サマリを表示するときの幅を整数で返します。

サマリを表示するときの幅を整数で返します。

@return サマリを表示するときの幅を整数で返します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n", " ...

• OptionParser

OptionParser#summary_width=(width) (58.0)

• 2.1.0

• インスタンスメソッド

サマリを表示するときの幅を整数で指定します。

サマリを表示するときの幅を整数で指定します。

@param width サマリを表示するときの幅を整数で指定します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n"...

• OptionParser

GetoptLong#set_options(*arguments) -> self (40.0)

• 2.1.0

• インスタンスメソッド

あなたのプログラムで、認識させたいオプションをセットします。 個々のオプションは、オプション名と引数のフラグからなる配列でな ければいけません。

あなたのプログラムで、認識させたいオプションをセットします。
個々のオプションは、オプション名と引数のフラグからなる配列でな
ければいけません。

配列中のオプション名は、一文字オプション (例: -d) か長いオプ
ション (例: --debug) を表した文字列のいずれかでなければなり
ません。配列の中の一番左端のオプション名が、オプションの正式名
になります。配列中の引数のフラグは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。

オ...

• GetoptLong

OptionParser#to_a -> [String] (40.0)

• 2.1.0

• インスタンスメソッド

サマリの各行を要素とした配列を返します。

サマリの各行を要素とした配列を返します。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.to_a # => ["Usage: test [options]", " -i, --init\n", " -u, --update\n", " -h, --help\n"]
//}

• OptionParser

絞り込み条件を変える

WIN32OLE#ole_method(method) -> WIN32OLE_METHOD (25.0)

• 2.1.0

• インスタンスメソッド

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。

メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。

OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。

@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発...

• WIN32OLE
• WIN32OLE_METHOD

OptionParser#parse!(argv = self.default_argv) -> [String] (22.0)

• 2.1.0

• インスタンスメソッド

与えられた argv をパースします。

与えられた argv をパースします。

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
...

• OptionParser

OptionParser#parse(*args) -> [String] (22.0)

• 2.1.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
...

• OptionParser

OptionParser#parse(argv) -> [String] (22.0)

• 2.1.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
...

• OptionParser

OptionParser#separator(sep) -> () (22.0)

• 2.1.0

• インスタンスメソッド

サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。

@param sep サマリの区切りを文字列で指定します。

//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator...

• OptionParser

絞り込み条件を変える