1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
package Win32::Registry;
=head1 NAME
Win32::Registry - accessing the Windows registry [obsolete, use Win32::TieRegistry]
=head1 SYNOPSIS
use Win32::Registry;
my $tips;
$::HKEY_LOCAL_MACHINE->Open("SOFTWARE\\Microsoft\\Windows"
."\\CurrentVersion\\Explorer\\Tips", $tips)
or die "Can't open tips: $^E";
my ($type, $value);
$tips->QueryValueEx("18", $type, $value) or die "No tip #18: $^E";
print "Here's a tip: $value\n";
=head1 DESCRIPTION
NOTE: This module provides a very klunky interface to access the
Windows registry, and is not currently being developed actively. It
only exists for backward compatibility with old code that uses it.
For more powerful and flexible ways to access the registry, use
Win32::TieRegistry.
Win32::Registry provides an object oriented interface to the Windows
Registry.
The following "root" registry objects are exported to the main:: name
space. Additional keys must be opened by calling the provided methods
on one of these.
$HKEY_CLASSES_ROOT
$HKEY_CURRENT_USER
$HKEY_LOCAL_MACHINE
$HKEY_USERS
$HKEY_PERFORMANCE_DATA
$HKEY_CURRENT_CONFIG
$HKEY_DYN_DATA
=cut
use strict;
require Exporter;
require DynaLoader;
use Win32::WinError;
require Win32 unless defined &Win32::GetLastError;
use vars qw($VERSION $AUTOLOAD @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
$VERSION = '0.07';
@ISA = qw( Exporter DynaLoader );
@EXPORT = qw(
HKEY_CLASSES_ROOT
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_PERFORMANCE_DATA
HKEY_CURRENT_CONFIG
HKEY_DYN_DATA
HKEY_USERS
KEY_ALL_ACCESS
KEY_CREATE_LINK
KEY_CREATE_SUB_KEY
KEY_ENUMERATE_SUB_KEYS
KEY_EXECUTE
KEY_NOTIFY
KEY_QUERY_VALUE
KEY_READ
KEY_SET_VALUE
KEY_WRITE
REG_BINARY
REG_CREATED_NEW_KEY
REG_DWORD
REG_DWORD_BIG_ENDIAN
REG_DWORD_LITTLE_ENDIAN
REG_EXPAND_SZ
REG_FULL_RESOURCE_DESCRIPTOR
REG_LEGAL_CHANGE_FILTER
REG_LEGAL_OPTION
REG_LINK
REG_MULTI_SZ
REG_NONE
REG_NOTIFY_CHANGE_ATTRIBUTES
REG_NOTIFY_CHANGE_LAST_SET
REG_NOTIFY_CHANGE_NAME
REG_NOTIFY_CHANGE_SECURITY
REG_OPENED_EXISTING_KEY
REG_OPTION_BACKUP_RESTORE
REG_OPTION_CREATE_LINK
REG_OPTION_NON_VOLATILE
REG_OPTION_RESERVED
REG_OPTION_VOLATILE
REG_REFRESH_HIVE
REG_RESOURCE_LIST
REG_RESOURCE_REQUIREMENTS_LIST
REG_SZ
REG_WHOLE_HIVE_VOLATILE
);
@EXPORT_OK = qw(
RegCloseKey
RegConnectRegistry
RegCreateKey
RegCreateKeyEx
RegDeleteKey
RegDeleteValue
RegEnumKey
RegEnumValue
RegFlushKey
RegGetKeySecurity
RegLoadKey
RegNotifyChangeKeyValue
RegOpenKey
RegOpenKeyEx
RegQueryInfoKey
RegQueryValue
RegQueryValueEx
RegReplaceKey
RegRestoreKey
RegSaveKey
RegSetKeySecurity
RegSetValue
RegSetValueEx
RegUnLoadKey
);
$EXPORT_TAGS{ALL}= \@EXPORT_OK;
bootstrap Win32::Registry;
sub import {
my $pkg = shift;
if ($_[0] && "Win32" eq $_[0]) {
Exporter::export($pkg, "Win32", @EXPORT_OK);
shift;
}
Win32::Registry->export_to_level(1+$Exporter::ExportLevel, $pkg, @_);
}
#######################################################################
# This AUTOLOAD is used to 'autoload' constants from the constant()
# XS function. If a constant is not found then control is passed
# to the AUTOLOAD in AutoLoader.
sub AUTOLOAD {
my($constname);
($constname = $AUTOLOAD) =~ s/.*:://;
#reset $! to zero to reset any current errors.
local $! = 0;
my $val = constant($constname, 0);
if ($! != 0) {
if ($! =~ /Invalid/) {
$AutoLoader::AUTOLOAD = $AUTOLOAD;
goto &AutoLoader::AUTOLOAD;
}
else {
my ($pack,$file,$line) = caller;
die "Unknown constant $constname in Win32::Registry "
. "at $file line $line.\n";
}
}
eval "sub $AUTOLOAD { $val }";
goto &$AUTOLOAD;
}
#######################################################################
# _new is a private constructor, not intended for public use.
#
sub _new {
my $self;
if ($_[0]) {
$self->{'handle'} = $_[0];
bless $self;
}
$self;
}
#define the basic registry objects to be exported.
#these had to be hardwired unfortunately.
# XXX Yuck!
{
package main;
use vars qw(
$HKEY_CLASSES_ROOT
$HKEY_CURRENT_USER
$HKEY_LOCAL_MACHINE
$HKEY_USERS
$HKEY_PERFORMANCE_DATA
$HKEY_CURRENT_CONFIG
$HKEY_DYN_DATA
);
}
$::HKEY_CLASSES_ROOT = _new(&HKEY_CLASSES_ROOT);
$::HKEY_CURRENT_USER = _new(&HKEY_CURRENT_USER);
$::HKEY_LOCAL_MACHINE = _new(&HKEY_LOCAL_MACHINE);
$::HKEY_USERS = _new(&HKEY_USERS);
$::HKEY_PERFORMANCE_DATA = _new(&HKEY_PERFORMANCE_DATA);
$::HKEY_CURRENT_CONFIG = _new(&HKEY_CURRENT_CONFIG);
$::HKEY_DYN_DATA = _new(&HKEY_DYN_DATA);
=head2 Methods
The following methods are supported. Note that subkeys can be
specified as a path name, separated by backslashes (which may
need to be doubled if you put them in double quotes).
=over 8
=item Open
$reg_obj->Open($sub_key_name, $sub_reg_obj);
Opens a subkey of a registry object, returning the new registry object
in $sub_reg_obj.
=cut
sub Open {
my $self = shift;
die 'usage: $obj->Open($sub_key_name, $sub_reg_obj)' if @_ != 2;
my ($subkey) = @_;
my ($result,$subhandle);
$result = RegOpenKey($self->{'handle'},$subkey,$subhandle);
$_[1] = _new($subhandle);
return 0 unless $_[1];
$! = Win32::GetLastError() unless $result;
return $result;
}
=item Close
$reg_obj->Close();
Closes an open registry key.
=cut
sub Close {
my $self = shift;
die 'usage: $obj->Close()' if @_ != 0;
return unless exists $self->{'handle'};
my $result = RegCloseKey($self->{'handle'});
if ($result) {
delete $self->{'handle'};
}
else {
$! = Win32::GetLastError();
}
return $result;
}
sub DESTROY {
my $self = shift;
return unless exists $self->{'handle'};
RegCloseKey($self->{'handle'});
delete $self->{'handle'};
}
=item Connect
$reg_obj->Connect($node_name, $new_reg_obj);
Connects to a remote Registry on the node specified by $node_name,
returning it in $new_reg_obj. Returns false if it fails.
=cut
sub Connect {
my $self = shift;
die 'usage: $obj->Connect($node_name, $new_reg_obj)' if @_ != 2;
my ($node) = @_;
my ($result,$subhandle);
$result = RegConnectRegistry ($node, $self->{'handle'}, $subhandle);
$_[1] = _new($subhandle);
return 0 unless $_[1];
$! = Win32::GetLastError() unless $result;
return $result;
}
=item Create
$reg_obj->Create($sub_key_name, $new_reg_obj);
Opens the subkey specified by $sub_key_name, returning the new registry
object in $new_reg_obj. If the specified subkey doesn't exist, it is
created.
=cut
sub Create {
my $self = shift;
die 'usage: $obj->Create($sub_key_name, $new_reg_obj)' if @_ != 2;
my ($subkey) = @_;
my ($result,$subhandle);
$result = RegCreateKey($self->{'handle'},$subkey,$subhandle);
$_[1] = _new ($subhandle);
return 0 unless $_[1];
$! = Win32::GetLastError() unless $result;
return $result;
}
=item SetValue
$reg_obj->SetValue($sub_key_name, $type, $value);
Sets the default value for a subkey specified by $sub_key_name.
=cut
sub SetValue {
my $self = shift;
die 'usage: $obj->SetValue($subkey, $type, $value)' if @_ != 3;
my $result = RegSetValue($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item SetValueEx
$reg_obj->SetValueEx($value_name, $reserved, $type, $value);
Sets the value for the value name identified by $value_name
in the key specified by $reg_obj.
=cut
sub SetValueEx {
my $self = shift;
die 'usage: $obj->SetValueEx($value_name, $reserved, $type, $value)' if @_ != 4;
my $result = RegSetValueEx($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item QueryValue
$reg_obj->QueryValue($sub_key_name, $value);
Gets the default value of the subkey specified by $sub_key_name.
=cut
sub QueryValue {
my $self = shift;
die 'usage: $obj->QueryValue($sub_key_name, $value)' if @_ != 2;
my $result = RegQueryValue($self->{'handle'}, $_[0], $_[1]);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item QueryKey
$reg_obj->QueryKey($classref, $number_of_subkeys, $number_of_values);
Gets information on a key specified by $reg_obj.
=cut
sub QueryKey {
my $garbage;
my $self = shift;
die 'usage: $obj->QueryKey($classref, $number_of_subkeys, $number_of_values)'
if @_ != 3;
my $result = RegQueryInfoKey($self->{'handle'}, $_[0],
$garbage, $garbage, $_[1],
$garbage, $garbage, $_[2],
$garbage, $garbage, $garbage, $garbage);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item QueryValueEx
$reg_obj->QueryValueEx($value_name, $type, $value);
Gets the value for the value name identified by $value_name
in the key specified by $reg_obj.
=cut
sub QueryValueEx {
my $self = shift;
die 'usage: $obj->QueryValueEx($value_name, $type, $value)' if @_ != 3;
my $result = RegQueryValueEx($self->{'handle'}, $_[0], undef, $_[1], $_[2]);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item GetKeys
my @keys;
$reg_obj->GetKeys(\@keys);
Populates the supplied array reference with the names of all the keys
within the registry object $reg_obj.
=cut
sub GetKeys {
my $self = shift;
die 'usage: $obj->GetKeys($arrayref)' if @_ != 1 or ref($_[0]) ne 'ARRAY';
my ($result, $i, $keyname);
$keyname = "DummyVal";
$i = 0;
$result = 1;
while ( $result ) {
$result = RegEnumKey( $self->{'handle'},$i++, $keyname );
if ($result) {
push( @{$_[0]}, $keyname );
}
}
return(1);
}
=item GetValues
my %values;
$reg_obj->GetValues(\%values);
Populates the supplied hash reference with entries of the form
$value_name => [ $value_name, $type, $data ]
for each value in the registry object $reg_obj.
=cut
sub GetValues {
my $self = shift;
die 'usage: $obj->GetValues($hashref)' if @_ != 1;
my ($result,$name,$type,$data,$i);
$name = "DummyVal";
$i = 0;
while ( $result=RegEnumValue( $self->{'handle'},
$i++,
$name,
undef,
$type,
$data ))
{
$_[0]->{$name} = [ $name, $type, $data ];
}
return(1);
}
=item DeleteKey
$reg_obj->DeleteKey($sub_key_name);
Deletes a subkey specified by $sub_key_name from the registry.
=cut
sub DeleteKey {
my $self = shift;
die 'usage: $obj->DeleteKey($sub_key_name)' if @_ != 1;
my $result = RegDeleteKey($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item DeleteValue
$reg_obj->DeleteValue($value_name);
Deletes a value identified by $value_name from the registry.
=cut
sub DeleteValue {
my $self = shift;
die 'usage: $obj->DeleteValue($value_name)' if @_ != 1;
my $result = RegDeleteValue($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item Save
$reg_obj->Save($filename);
Saves the hive specified by $reg_obj to a file.
=cut
sub Save {
my $self = shift;
die 'usage: $obj->Save($filename)' if @_ != 1;
my $result = RegSaveKey($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item Load
$reg_obj->Load($sub_key_name, $file_name);
Loads a key specified by $sub_key_name from a file.
=cut
sub Load {
my $self = shift;
die 'usage: $obj->Load($sub_key_name, $file_name)' if @_ != 2;
my $result = RegLoadKey($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
=item UnLoad
$reg_obj->Unload($sub_key_name);
Unloads a registry hive.
=cut
sub UnLoad {
my $self = shift;
die 'usage: $obj->UnLoad($sub_key_name)' if @_ != 1;
my $result = RegUnLoadKey($self->{'handle'}, @_);
$! = Win32::GetLastError() unless $result;
return $result;
}
1;
__END__
|