Class: Win32::Registry

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Constants
Defined in:
lib/win32/registry.rb

Direct Known Subclasses

PredefinedKey

Defined Under Namespace

Modules: API, Constants Classes: Error, PredefinedKey

Constant Summary collapse

@@type2name = 
%w[
  REG_NONE REG_SZ REG_EXPAND_SZ REG_BINARY REG_DWORD
  REG_DWORD_BIG_ENDIAN REG_LINK REG_MULTI_SZ
  REG_RESOURCE_LIST REG_FULL_RESOURCE_DESCRIPTOR
  REG_RESOURCE_REQUIREMENTS_LIST REG_QWORD
].inject([]) do |ary, type|
  type.freeze
  ary[Constants.const_get(type)] = type
  ary
end.freeze
@@final =

finalizer

proc { |hkey| proc { API.CloseKey(hkey[0]) if hkey[0] } }

Constants included from Constants

Constants::HKEY_CLASSES_ROOT, Constants::HKEY_CURRENT_CONFIG, Constants::HKEY_CURRENT_USER, Constants::HKEY_DYN_DATA, Constants::HKEY_LOCAL_MACHINE, Constants::HKEY_PERFORMANCE_DATA, Constants::HKEY_PERFORMANCE_NLSTEXT, Constants::HKEY_PERFORMANCE_TEXT, Constants::HKEY_USERS, Constants::KEY_ALL_ACCESS, Constants::KEY_CREATE_LINK, Constants::KEY_CREATE_SUB_KEY, Constants::KEY_ENUMERATE_SUB_KEYS, Constants::KEY_EXECUTE, Constants::KEY_NOTIFY, Constants::KEY_QUERY_VALUE, Constants::KEY_READ, Constants::KEY_SET_VALUE, Constants::KEY_WRITE, Constants::MAX_KEY_LENGTH, Constants::MAX_VALUE_LENGTH, Constants::REG_BINARY, Constants::REG_CREATED_NEW_KEY, Constants::REG_DWORD, Constants::REG_DWORD_BIG_ENDIAN, Constants::REG_DWORD_LITTLE_ENDIAN, Constants::REG_EXPAND_SZ, Constants::REG_FORCE_RESTORE, Constants::REG_FULL_RESOURCE_DESCRIPTOR, Constants::REG_LEGAL_OPTION, Constants::REG_LINK, Constants::REG_MULTI_SZ, Constants::REG_NONE, Constants::REG_NO_LAZY_FLUSH, Constants::REG_OPENED_EXISTING_KEY, Constants::REG_OPTION_BACKUP_RESTORE, Constants::REG_OPTION_CREATE_LINK, Constants::REG_OPTION_NON_VOLATILE, Constants::REG_OPTION_OPEN_LINK, Constants::REG_OPTION_RESERVED, Constants::REG_OPTION_VOLATILE, Constants::REG_QWORD, Constants::REG_QWORD_LITTLE_ENDIAN, Constants::REG_REFRESH_HIVE, Constants::REG_RESOURCE_LIST, Constants::REG_RESOURCE_REQUIREMENTS_LIST, Constants::REG_SZ, Constants::REG_WHOLE_HIVE_VOLATILE, Constants::STANDARD_RIGHTS_READ, Constants::STANDARD_RIGHTS_WRITE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hkey, parent, keyname, disposition) ⇒ Registry

initialize



479
480
481
482
483
484
485
486
 
# File '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

Instance Attribute Details

#disposition ⇒ Object (readonly)

Disposition value (REG_CREATED_NEW_KEY or REG_OPENED_EXISTING_KEY).



496
497
498
 
# File 'lib/win32/registry.rb', line 496

def disposition
  @disposition
end

#hkey ⇒ Object (readonly)

Returns key handle value.



489
490
491
 
# File 'lib/win32/registry.rb', line 489

def hkey
  @hkey
end

#keyname ⇒ Object (readonly)

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



494
495
496
 
# File 'lib/win32/registry.rb', line 494

def keyname
  @keyname
end

#parent ⇒ Object (readonly)

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



491
492
493
 
# File 'lib/win32/registry.rb', line 491

def parent
  @parent
end

Class Method Details

.create(hkey, subkey, desired = KEY_ALL_ACCESS, opt = REG_OPTION_RESERVED) ⇒ Object

— 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.



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File '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) ⇒ Object

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.



373
374
375
376
377
378
379
 
# File '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

.open(hkey, subkey, desired = KEY_READ, opt = REG_OPTION_RESERVED) ⇒ Object

— 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.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File '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) ⇒ Object

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



409
410
411
 
# File 'lib/win32/registry.rb', line 409

def self.time2wtime(time)
  time.to_i * 10000000 + 116444736000000000
end

.type2name(type) ⇒ Object

Convert registry type value to readable string.



395
396
397
 
# File 'lib/win32/registry.rb', line 395

def self.type2name(type)
  @@type2name[type] || type.to_s
end

.wtime2time(wtime) ⇒ Object

Convert 64-bit FILETIME integer into Time object.



402
403
404
 
# File 'lib/win32/registry.rb', line 402

def self.wtime2time(wtime)
  Time.at((wtime - 116444736000000000) / 10000000)
end

Instance Method Details

#[](name, *rtype) ⇒ Object

Read a registry value named name and return its value data. The class of value is same as #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 same as #read method.



679
680
681
682
683
684
685
686
687
688
689
 
# File '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) ⇒ Object

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



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File '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) ⇒ Object

marshalling is not allowed

Raises:

  • (TypeError) 


534
535
536
 
# File 'lib/win32/registry.rb', line 534

def _dump(depth)
  raise TypeError, "can't dump Win32::Registry"
end

#close ⇒ Object

Close key.

After close, most method raise an error.



557
558
559
560
561
 
# File '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) ⇒ Object

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



548
549
550
 
# File '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? ⇒ Boolean

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

Returns:

  • (Boolean) 


504
505
506
 
# File 'lib/win32/registry.rb', line 504

def created?
  @disposition == REG_CREATED_NEW_KEY
end

#delete_key(name, recursive = false) ⇒ Object

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.



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File '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) ⇒ Object Also known as: delete

Delete a registry value named name. We can not delete the ‘default’ value.



829
830
831
 
# File 'lib/win32/registry.rb', line 829

def delete_value(name)
  API.DeleteValue(@hkey, name)
end

#each_key ⇒ Object

Enumerate subkeys.

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



603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File '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 ⇒ Object Also known as: each

Enumerate values.



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File '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

#flush ⇒ Object

Write all the attributes into the registry file.



865
866
867
 
# File 'lib/win32/registry.rb', line 865

def flush
  API.FlushKey @hkey
end

#info ⇒ Object

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.



888
889
890
 
# File 'lib/win32/registry.rb', line 888

def info
  API.QueryInfoKey(@hkey)
end

#inspect ⇒ Object 



527
528
529
 
# File 'lib/win32/registry.rb', line 527

def inspect
  "\#<Win32::Registry key=#{name.inspect}>"
end

#keys ⇒ Object

return keys as an array



621
622
623
624
625
 
# File 'lib/win32/registry.rb', line 621

def keys
  keys_ary = []
  each_key { |key,| keys_ary << key }
  keys_ary
end

#name ⇒ Object

Full path of key such as ‘HKEY_CURRENT_USERSOFTWAREfoobar’.



518
519
520
521
522
523
524
525
 
# File '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) ⇒ Object

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



541
542
543
 
# File '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? ⇒ Boolean

Returns if key is not closed.

Returns:

  • (Boolean) 


511
512
513
 
# File 'lib/win32/registry.rb', line 511

def open?
  !@hkey.nil?
end

#read(name, *rtype) ⇒ Object

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.



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File '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) ⇒ Object

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.



730
731
732
 
# File 'lib/win32/registry.rb', line 730

def read_bin(name)
  read(name, REG_BINARY)[1]
end

#read_i(name) ⇒ Object

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.



720
721
722
 
# File '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) ⇒ Object

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.



695
696
697
 
# File 'lib/win32/registry.rb', line 695

def read_s(name)
  read(name, REG_SZ)[1]
end

#read_s_expand(name) ⇒ Object

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.



705
706
707
708
709
710
711
712
 
# File '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 ⇒ Object

return values as an array



590
591
592
593
594
 
# File 'lib/win32/registry.rb', line 590

def values
  vals_ary = []
  each_value { |*, val| vals_ary << val }
  vals_ary
end

#write(name, type, data) ⇒ Object

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.



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File '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) ⇒ Object

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).



821
822
823
 
# File 'lib/win32/registry.rb', line 821

def write_bin(name, value)
  write name, REG_BINARY, value.to_s
end

#write_i(name, value) ⇒ Object

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).



811
812
813
 
# File 'lib/win32/registry.rb', line 811

def write_i(name, value)
  write name, REG_DWORD, value.to_i
end

#write_s(name, value) ⇒ Object

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).



801
802
803
 
# File 'lib/win32/registry.rb', line 801

def write_s(name, value)
  write name, REG_SZ, value.to_s
end