Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > win32/registryライブラリ > Win32::Registryクラス

class Win32::Registry

クラスの継承リスト: Win32::Registry < Enumerable < Win32::Registry::Constants < Object < Kernel < BasicObject

要約

目次

特異メソッド
create expand_environ new open time2wtime type2name wtime2time
インスタンスメソッド
[] []= _dump close create created? delete delete_value delete_key descriptor_length max_key_length max_value_length max_value_name_length num_keys num_values wtime disposition each each_value each_key flush hkey info inspect keyname keys name to_s open open? opened? parent read read_bin read_i read_s read_s_expand write write_bin write_i write_s
定数
HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_DYN_DATA HKEY_LOCAL_MACHINE HKEY_PERFORMANCE_DATA HKEY_PERFORMANCE_NLSTEXT HKEY_PERFORMANCE_TEXT HKEY_USERS

特異メソッド

create(key, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED)[permalink][rdoc]
create(key, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED) {|reg| ... }

[TODO]

レジストリキー key 下にキー subkey を作成し， 開いたキーを表す Win32::Registry オブジェクトを返します。 key は親のキーを Win32::Registry オブジェクトで指定します。 親のキーには定義済キー HKEY_* を使用できます (⇒Win32::Registry::Constants)

サブキーが既に存在していればキーはただ開かれ，Win32::Registry#created? メソッドが false を返します。

ブロックが与えられると，キーは自動的に閉じられます。

expand_environ(str)[permalink][rdoc]

[TODO]

str の %\w+% という並びを環境変数に置換します。 REG_EXPAND_SZ で用いられます。

詳細は以下の Win32 API を参照してください。

new(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED)[permalink][rdoc]
new(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED) {|reg| ... }
open(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED)
open(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED) {|reg| ... }

[TODO]

レジストリキー key 下のキー subkey を開き， 開いたキーを表す Win32::Registry オブジェクトを返します。 key は親のキーを Win32::Registry オブジェクトで指定します。 親のキーには定義済キー HKEY_* を使用できます (⇒Win32::Registry::Constants)

desired はアクセスマスクです。opt はキーのオプションです。 詳細は以下の MSDN Library を参照してください。

ブロックが与えられると，キーは自動的に閉じられます。

time2wtime(time)[permalink][rdoc]

[TODO]

Time オブジェクトまたは Integer オブジェクトを受け取り， 64bit の FILETIME に変換します。

type2name(type)[permalink][rdoc]

[TODO]

レジストリ値の型を整数から可読文字列に変換します。

wtime2time(wtime)[permalink][rdoc]

[TODO]

64bit の FILETIME を Time オブジェクトに変換します。

詳細は以下の MSDN Library を参照してください。

インスタンスメソッド

self[name, wtype = nil][permalink][rdoc]

[TODO]

レジストリ値 name に value を書き込みます。

オプション引数 wtype を指定した場合は，その型で書き込みます。 指定しなかった場合，value のクラスに応じて次の型で書き込みます:

self[name, rtype] = value = nil[permalink][rdoc]

[TODO]

_dump[permalink][rdoc]

[TODO]

close[permalink][rdoc]

[TODO]

開かれているキーを閉じます。

閉じられた後では，多くのメソッドは例外を発生します。

create(subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED)[permalink][rdoc]

[TODO]

Win32::Registry.create(self, subkey, desired, opt) と同じです。

created?[permalink][rdoc]

[TODO]

キーが新しく作成された場合，真を返します。 (⇒Win32::Registry.create)

delete(name)[permalink][rdoc]
delete_value(name)

[TODO]

レジストリ値 name を削除します。 (標準) レジストリ値を削除することはできません。

delete_key(name, recursive = false)[permalink][rdoc]

[TODO]

サブキー name とそのキーが持つすべての値を削除します。

recursive が false の場合，そのサブキーはサブキーを持っていてはなりません。 true の場合，キーは再帰的に削除されます。

num_keys[permalink][rdoc]
max_key_length
num_values
max_value_name_length
max_value_length
descriptor_length
wtime

[TODO]

キー情報の個々の値を返します。

disposition[permalink][rdoc]

[TODO]

キーの disposition 値を返します。 (REG_CREATED_NEW_KEY または REG_OPENED_EXISTING_KEY)

each {|name, type, value| ... }[permalink][rdoc]
each_value {|name, type, value| ... }

[TODO]

キーが持つレジストリ値を列挙します。

each_key {|subkey, wtime| ... }[permalink][rdoc]

[TODO]

キーのサブキーを列挙します。

subkey はサブキーの名前を表す String です。 wtime は最終更新時刻を表す FILETIME (64-bit 整数) です。 (⇒Win32::Registry.wtime2time)

flush[permalink][rdoc]

[TODO]

キーの全てのデータをレジストリファイルに書き込みます。

hkey[permalink][rdoc]

[TODO]

info[permalink][rdoc]

[TODO]

キー情報を以下の値の配列で返します:

詳細は以下の Win32 API を参照してください。

inspect[permalink][rdoc]

[TODO]

keyname[permalink][rdoc]

[TODO]

Win32::Registry.open または Win32::Registry.create に指定された subkey の値を返します。

keys[permalink][rdoc]

[TODO]

name[permalink][rdoc]
to_s

[TODO]

キーのフルパスを 'HKEY_CURRENT_USER\SOFTWARE\foo\bar' のような形で返します。

open(subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED)[permalink][rdoc]

[TODO]

Win32::Registry.open(self, subkey, desired, opt) と同じです。

open?[permalink][rdoc]

[TODO]

opened?[permalink][rdoc]

[TODO]

キーがまだ閉じられていない場合，真を返します。

parent[permalink][rdoc]

[TODO]

親のキーを表す Win32::Registry オブジェクトを返します。 定義済キーでは nil を返します。

read(name, *rtype)[permalink][rdoc]

[TODO]

レジストリ値 name を読み，[ type, data ] の配列で返します。 name が nil の場合，(標準) レジストリ値が読み込まれます。

type はレジストリ値の型です。(⇒Win32::Registry::Constants) data はレジストリ値のデータで，クラスは以下の通りです:

オプション引数 rtype が指定されていた場合，レジストリ値の型が 与えられた rtype の配列に存在するかチェックされ，存在しない場合に TypeError が発生します。

read_s(name)[permalink][rdoc]
read_i(name)
read_bin(name)

[TODO]

型がそれぞれ REG_SZ(read_s), REG_DWORD(read_i), REG_BINARY(read_bin) であるレジストリ値 name を読み，その値を返します。

型がマッチしなかった場合，TypeError が発生します。

read_s_expand(name)[permalink][rdoc]

[TODO]

型が REG_SZ または REG_EXPAND_SZ であるレジストリ値 name を読み， その値を返します。

型が REG_EXPAND_SZ だった場合，環境変数が置換された値が返ります。 REG_SZ または REG_EXPAND_SZ 以外だった場合，TypeError が発生します。

write(name, type, data)[permalink][rdoc]

[TODO]

レジストリ値 name に型 type で data を書き込みます。 name が nil の場合，(標準) レジストリ値に書き込みます。

type はレジストリ値の型です。(⇒Win32::Registry::Constants) data のクラスは Win32::Registry#read メソッドに準じていなければなりません。

write_s(name, value)[permalink][rdoc]
write_i(name, value)
write_bin(name, value)

[TODO]

レジストリ値 name に value を書き込みます。

レジストリ値の型はそれぞれ REG_SZ(write_s), REG_DWORD(write_i), REG_BINARY(write_bin) です。

定数

HKEY_CLASSES_ROOT -> Win32::Registry[permalink][rdoc]
HKEY_CURRENT_USER -> Win32::Registry
HKEY_LOCAL_MACHINE -> Win32::Registry
HKEY_USERS -> Win32::Registry
HKEY_PERFORMANCE_DATA -> Win32::Registry
HKEY_PERFORMANCE_TEXT -> Win32::Registry
HKEY_PERFORMANCE_NLSTEXT -> Win32::Registry
HKEY_CURRENT_CONFIG -> Win32::Registry
HKEY_DYN_DATA -> Win32::Registry

[TODO]

それぞれの定義済キーを表す Win32::Registry オブジェクトです。

詳細は以下の MSDN Library を参照してください。