Home Classes Methods

In Files

ruby-3.1.2/ext/win32/lib/win32/registry.rb
ruby-3.1.2/ext/win32/lib/win32/resolv.rb

Parent

Object

Namespace

Methods

::create
::expand_environ
::new
::open
::time2wtime
::type2name
::wtime2time
#[]
#[]=
#_dump
#close
#create
#created?
#delete
#delete_key
#delete_value
#each
#each_key
#each_value
#flush
#info
#inspect
#keys
#name
#open
#open?
#read
#read_bin
#read_i
#read_s
#read_s_expand
#values
#write
#write_bin
#write_i
#write_s

Included Modules

Files

Class/Module Index

Win32::Registry

Attributes

disposition[R]

Disposition value (REG_CREATED_NEW_KEY or REG_OPENED_EXISTING_KEY).

hkey[R]

Returns key handle value.

keyname[R]

Same as subkey value of Registry.open or Registry.create method.

parent[R]

Win32::Registry object of parent key, or nil if predefeined key.

Public Class Methods

create(hkey, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED) click to toggle source

— Registry.create(key, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED)

— Registry.create(key, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED) { |reg| … }

Create or open the registry key subkey under key. You can use predefined key HKEY_* (see Constants)

If subkey is already exists, key is opened and Registry#created? method will return false.

If block is given, the key is closed automatically.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 457
def self.create(hkey, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED)
  newkey, disp = API.CreateKey(hkey.hkey, subkey, opt, desired)
  obj = new(newkey, hkey, subkey, disp)
  if block_given?
    begin
      yield obj
    ensure
      obj.close
    end
  else
    obj
  end
end

expand_environ(str) click to toggle source

Replace %w+% into the environment value of what is contained between the %'s This method is used for REG_EXPAND_SZ.

For detail, see expandEnvironmentStrings Win32 API.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 373
def self.expand_environ(str)
  str.gsub(Regexp.compile("%([^%]+)%".encode(str.encoding))) {
    v = $1.encode(LOCALE)
    (e = ENV[v] || ENV[v.upcase]; e.encode(str.encoding) if e) ||
    $&
  }
end

new(hkey, parent, keyname, disposition) click to toggle source

initialize

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 479
def initialize(hkey, parent, keyname, disposition)
  @hkey = hkey
  @parent = parent
  @keyname = keyname
  @disposition = disposition
  @hkeyfinal = [ hkey ]
  ObjectSpace.define_finalizer self, @@final.call(@hkeyfinal)
end

open(hkey, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED) click to toggle source

— Registry.open(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED)

— Registry.open(key, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED) { |reg| … }

Open the registry key subkey under key. key is Win32::Registry object of parent key. You can use predefined key HKEY_* (see Constants) desired and opt is access mask and key option. For detail, see the MSDN. If block is given, the key is closed automatically.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 429
def self.open(hkey, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED)
  subkey = subkey.chomp('\\')
  newkey = API.OpenKey(hkey.hkey, subkey, opt, desired)
  obj = new(newkey, hkey, subkey, REG_OPENED_EXISTING_KEY)
  if block_given?
    begin
      yield obj
    ensure
      obj.close
    end
  else
    obj
  end
end

time2wtime(time) click to toggle source

Convert Time object or Integer object into 64-bit FILETIME.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 409
def self.time2wtime(time)
  time.to_i * 10000000 + 116444736000000000
end

type2name(type) click to toggle source

Convert registry type value to readable string.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 395
def self.type2name(type)
  @@type2name[type] || type.to_s
end

wtime2time(wtime) click to toggle source

Convert 64-bit FILETIME integer into Time object.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 402
def self.wtime2time(wtime)
  Time.at((wtime - 116444736000000000) / 10000000)
end

Public Instance Methods

[](name, *rtype) click to toggle source

Read a registry value named name and return its value data. The class of the value is the same as the read method returns.

If the value type is REG_EXPAND_SZ, returns value data whose environment variables are replaced. If the value type is neither REG_SZ, REG_MULTI_SZ, REG_DWORD, REG_DWORD_BIG_ENDIAN, nor REG_QWORD, TypeError is raised.

The meaning of rtype is the same as for the read method.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 679
def [](name, *rtype)
  type, data = read(name, *rtype)
  case type
  when REG_SZ, REG_DWORD, REG_QWORD, REG_MULTI_SZ
    data
  when REG_EXPAND_SZ
    Registry.expand_environ(data)
  else
    raise TypeError, "Type #{Registry.type2name(type)} is not supported."
  end
end

[]=(name, rtype, value = nil) click to toggle source

Write value to a registry value named name.

If wtype is specified, the value type is it. Otherwise, the value type is depend on class of value: :Integer

REG_DWORD

:String

REG_SZ

:Array

REG_MULTI_SZ

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 777
def []=(name, rtype, value = nil)
  if value
    write name, rtype, value
  else
    case value = rtype
    when Integer
      write name, REG_DWORD, value
    when String
      write name, REG_SZ, value
    when Array
      write name, REG_MULTI_SZ, value
    else
      raise TypeError, "Unexpected type #{value.class}"
    end
  end
  value
end

_dump(depth) click to toggle source

marshalling is not allowed

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 534
def _dump(depth)
  raise TypeError, "can't dump Win32::Registry"
end

close() click to toggle source

Close key.

After close, most method raise an error.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 557
def close
  API.CloseKey(@hkey)
  @hkey = @parent = @keyname = nil
  @hkeyfinal[0] = nil
end

create(subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED, &blk) click to toggle source

Same as Win32::Registry.create (self, subkey, desired, opt)

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 548
def create(subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED, &blk)
  self.class.create(self, subkey, desired, opt, &blk)
end

created?() click to toggle source

Returns if key is created ((newly)). (see Registry.create) – basically you call create then when you call created? on the instance returned it will tell if it was successful or not

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 504
def created?
  @disposition == REG_CREATED_NEW_KEY
end

delete(name) click to toggle source

Alias for: delete_value

delete_key(name, recursive = false) click to toggle source

Delete a subkey named name and all its values.

If recursive is false, the subkey must not have subkeys. Otherwise, this method deletes all subkeys and values recursively.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 840
def delete_key(name, recursive = false)
  if recursive
    open(name, KEY_ALL_ACCESS) do |reg|
      reg.keys.each do |key|
        begin
          reg.delete_key(key, true)
        rescue Error
          #
        end
      end
    end
    API.DeleteKey(@hkey, name)
  else
    begin
      API.EnumKey @hkey, 0
    rescue Error
      return API.DeleteKey(@hkey, name)
    end
    raise Error.new(5) ## ERROR_ACCESS_DENIED
  end
end

delete_value(name) click to toggle source

Delete a registry value named name. We can not delete the `default' value.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 829
def delete_value(name)
  API.DeleteValue(@hkey, name)
end

Also aliased as: delete

each() click to toggle source

Alias for: each_value

each_key() click to toggle source

Enumerate subkeys.

subkey is String which contains name of subkey. wtime is last write time as FILETIME (64-bit integer). (see Registry.wtime2time)

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 603
def each_key
  index = 0
  while true
    begin
      subkey, wtime = API.EnumKey(@hkey, index)
    rescue Error
      break
    end
    subkey = export_string(subkey)
    yield subkey, wtime
    index += 1
  end
  index
end

each_value() click to toggle source

Enumerate values.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 566
def each_value
  index = 0
  while true
    begin
      subkey = API.EnumValue(@hkey, index)
    rescue Error
      break
    end
    subkey = export_string(subkey)
    begin
      type, data = read(subkey)
    rescue Error
    else
      yield subkey, type, data
    end
    index += 1
  end
  index
end

Also aliased as: each

flush() click to toggle source

Write all the attributes into the registry file.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 865
def flush
  API.FlushKey @hkey
end

info() click to toggle source

Returns key information as Array of: :num_keys

The number of subkeys.

:max_key_length

Maximum length of name of subkeys.

:num_values

The number of values.

:max_value_name_length

Maximum length of name of values.

:max_value_length

Maximum length of value of values.

:descriptor_length

Length of security descriptor.

:wtime

Last write time as FILETIME(64-bit integer)

For detail, see RegQueryInfoKey Win32 API.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 888
def info
  API.QueryInfoKey(@hkey)
end

inspect() click to toggle source

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 527
def inspect
  "\#<Win32::Registry key=#{name.inspect}>"
end

keys() click to toggle source

return keys as an array

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 621
def keys
  keys_ary = []
  each_key { |key,| keys_ary << key }
  keys_ary
end

name() click to toggle source

Full path of key such as 'HKEY_CURRENT_USERSOFTWAREfoobar'.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 518
def name
  parent = self
  name = @keyname
  while parent = parent.parent
    name = parent.keyname + '\\' + name
  end
  name
end

open(subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED, &blk) click to toggle source

Same as Win32::Registry.open (self, subkey, desired, opt)

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 541
def open(subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED, &blk)
  self.class.open(self, subkey, desired, opt, &blk)
end

open?() click to toggle source

Returns if key is not closed.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 511
def open?
  !@hkey.nil?
end

read(name, *rtype) click to toggle source

Read a registry value named name and return array of [ type, data ]. When name is nil, the `default' value is read. type is value type. (see Win32::Registry::Constants module) data is value data, its class is: :REG_SZ, REG_EXPAND_SZ

String

:REG_MULTI_SZ

Array of String

:REG_DWORD, REG_DWORD_BIG_ENDIAN, REG_QWORD

Integer

:REG_BINARY, REG_NONE

String (contains binary data)

When rtype is specified, the value type must be included by rtype array, or TypeError is raised.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 643
def read(name, *rtype)
  type, data = API.QueryValue(@hkey, name)
  unless rtype.empty? or rtype.include?(type)
    raise TypeError, "Type mismatch (expect [#{
      rtype.map{|t|Registry.type2name(t)}.join(', ')}] but #{
      Registry.type2name(type)} present)"
  end
  case type
  when REG_SZ, REG_EXPAND_SZ
    [ type, data.encode(name.encoding, WCHAR).chop ]
  when REG_MULTI_SZ
    [ type, data.encode(name.encoding, WCHAR).split(/\0/) ]
  when REG_BINARY, REG_NONE
    [ type, data ]
  when REG_DWORD
    [ type, API.unpackdw(data) ]
  when REG_DWORD_BIG_ENDIAN
    [ type, data.unpack('N')[0] ]
  when REG_QWORD
    [ type, API.unpackqw(data) ]
  else
    raise TypeError, "Type #{Registry.type2name(type)} is not supported."
  end
end

read_bin(name) click to toggle source

Read a REG_SZ(read_s), REG_DWORD(read_i), or REG_BINARY(read_bin) registry value named name.

If the values type does not match, TypeError is raised.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 730
def read_bin(name)
  read(name, REG_BINARY)[1]
end

read_i(name) click to toggle source

Read a REG_SZ(read_s), REG_DWORD(read_i), or REG_BINARY(read_bin) registry value named name.

If the values type does not match, TypeError is raised.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 720
def read_i(name)
  read(name, REG_DWORD, REG_DWORD_BIG_ENDIAN, REG_QWORD)[1]
end

read_s(name) click to toggle source

Read a REG_SZ(read_s), REG_DWORD(read_i), or REG_BINARY(read_bin) registry value named name.

If the values type does not match, TypeError is raised.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 695
def read_s(name)
  read(name, REG_SZ)[1]
end

read_s_expand(name) click to toggle source

Read a REG_SZ or REG_EXPAND_SZ registry value named name.

If the value type is REG_EXPAND_SZ, environment variables are replaced. Unless the value type is REG_SZ or REG_EXPAND_SZ, TypeError is raised.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 705
def read_s_expand(name)
  type, data = read(name, REG_SZ, REG_EXPAND_SZ)
  if type == REG_EXPAND_SZ
    Registry.expand_environ(data)
  else
    data
  end
end

values() click to toggle source

return values as an array

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 590
def values
  vals_ary = []
  each_value { |*, val| vals_ary << val }
  vals_ary
end

write(name, type, data) click to toggle source

Write data to a registry value named name. When name is nil, write to the `default' value.

type is type value. (see Registry::Constants module) Class of data must be same as which read method returns.

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 742
def write(name, type, data)
  termsize = 0
  case type
  when REG_SZ, REG_EXPAND_SZ
    data = data.encode(WCHAR)
    termsize = WCHAR_SIZE
  when REG_MULTI_SZ
    data = data.to_a.map {|s| s.encode(WCHAR)}.join(WCHAR_NUL) << WCHAR_NUL
    termsize = WCHAR_SIZE
  when REG_BINARY, REG_NONE
    data = data.to_s
  when REG_DWORD
    data = API.packdw(data.to_i)
  when REG_DWORD_BIG_ENDIAN
    data = [data.to_i].pack('N')
  when REG_QWORD
    data = API.packqw(data.to_i)
  else
    raise TypeError, "Unsupported type #{Registry.type2name(type)}"
  end
  API.SetValue(@hkey, name, type, data, data.bytesize + termsize)
end

write_bin(name, value) click to toggle source

Write value to a registry value named name.

The value type is REG_SZ(write_s), REG_DWORD(write_i), or REG_BINARY(write_bin).

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 821
def write_bin(name, value)
  write name, REG_BINARY, value.to_s
end

write_i(name, value) click to toggle source

Write value to a registry value named name.

The value type is REG_SZ(write_s), REG_DWORD(write_i), or REG_BINARY(write_bin).

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 811
def write_i(name, value)
  write name, REG_DWORD, value.to_i
end

write_s(name, value) click to toggle source

Write value to a registry value named name.

The value type is REG_SZ(write_s), REG_DWORD(write_i), or REG_BINARY(write_bin).

 
               # File ruby-3.1.2/ext/win32/lib/win32/registry.rb, line 801
def write_s(name, value)
  write name, REG_SZ, value.to_s
end