View on
MetaCPAN
search.cpan.org is shutting down
For details read Perl NOC. After June 25th this page will redirect to MetaCPAN.org
Albert K. T. Hui > Win32-Registry-File > Win32::Registry::File

Download:
Win32-Registry-File-1.10.zip

Dependencies

Annotate this POD

CPAN RT

New  4
Open  0
View/Report Bugs
Module Version: 1.10   Source  

NAME ^

Win32::Registry::File - Perl interface to MS-Windows registry files.

SYNOPSIS ^

    use Win32::Registry::File;
    $reg = new Win32::Registry::File('system.reg');

    print $reg->get(['system', 'path']);
    $oldpath = $reg->put(['system', 'path', 'C:\\windows']);
    if ($reg->exists(['system', 'path'])) ...
    $reg->delete(['system', 'path']);

    $reg->save;

DESCRIPTION ^

This package provides easy access to MS-Windows registry files with automatic conversion from native Perl to Windows registry data encoding and vice versa.

For an .reg file to be recognized it must be of the following format:

    REGEDIT4

    [section]
    "key"=value           ; comments

In our implementation the key must be no longer than 1024 characters, and contain no high-ASCII nor control character.

On a line, everything after the semicolon (;) is ignored. Backslash (\) right before the end of line is treated as line continuation marker and the contents of the next line will be appended after stripping off preceeding whitespaces. Comment delimiter takes precedence over line continuation marker. Spaces surrounding the delimiting equation sign are stripped. If there are more than one equation sign on a line the first one is treated as the delimiter, the rest of them are considered part of the value.

The comment delimiter can be specified during calls to new or open via the -commentdelim option as a regular expression. If no comment stripping is desired supply the empty string ('') as the argument.

Specifcations of section, key and value are to be supplied to methods via an array reference containing just a section name, or the section name plus a key name, or the section name plus a key name with its associated value.

All values are automatically converted to and from native Perl/Windows registry formats. For special situations you can use the decode_reg_value subroutine for manual decoding.

METHODS ^

new([filename])

Constructor. If a filename is supplied it will be opened as an .reg file with its content read as the initial configuration of the object.

open(self[, filename])

Open the .reg file and read in all valid entries. New entries will be merged with the existing configuration.

save(self[, filename])

Save the current configuration into file in the .reg format. Both the section order and the order of key=value pairs within a section are preserved. If a filename is given the file will be used as the save target, otherwise the configuration will be save to the last used (via new, open or save) file. The original content of the file will be clobbered. Be careful not to inadvertently merge two .reg files into one by opening them in turn and then saving.

True will be returned if the save is successful, false otherwise.

file(self[, filename] )

Set or retrieve the filename that was last used. new, open and save will all update the last used filename if a filename was supplied to them.

lastpos(self)

Set or retrieve the byte offset into the file immediately after the last line that conforms to the .reg format.

registry(self)

Set or retrieve the registry flag which determines whether the file is to be treated as a registry file or .reg file. If this flag is true all subsequent file operations will work in registry file mode, otherwise the .reg mode is used. Normally this flag need not be altered manually because it is automatically set to a value matching the format of the most recently read file.

commentdelim(self)

Set or retrieve the comment delimiter.

exists(self, [ section[, key[, value]] ])

Return true if the specified section exists, or if the specified key exists in the specified section. If a value is specified, return true if it is any one of the values of the key.

get(self, [ section[, key[, value]] ])

Depending on how many elements are specified in the array reference, retrieve the entire specified section or the values of the specified key.

If nothing is specified the entire file is returned as a hash reference.

If only a section name is specified the matching section is returned in its entirety as a hash reference.

If both a section name and a key name are specified, the associated values are returned.

put(self, [ section[, key[, value]] ][, -add = boolean])>

Set the value for the specified key in the specified section and return the old value. If the optional -add argument is true a new value will be added to the key if that value does not already exist.

decode_reg_value(value)

Returns a decoded value or list of values from a registry key. See the section above on "Registry Format". This routine accepts the raw value field from a registry entry, and return a Perl specific data structure that natively represents the data.

This routine is called automatically when either get or set methods are called specifying a particular key. If you used get to retrieve a whole section, the values of the registry keys will be in their native file format. You must use this method call to convert them from registry to Perl format.

delete(self, [ section[, key[, value]] ][, -keep = boolean])>

If section, key and value are all given the corresponding key=value pair will be deleted from the specified section. If a specific value is not given the entire key including all its values will be deleted. If the path only specifies a section the entire section will be deleted.

If the optional -keep argument evaluates to true, when performing section deletion all the keys along with their values are deleted but the now empty section will still exist to mimic the bahavior of the Unreal uninstaller.

adjustfilecase(filename[, dirname])

Return the properly cased filename by performing a case-insensitive match of the specified file within the specified parent directory. If there is no match the filename passed in is return as-is. If the dirname argument is not given the current directory will be used.

adjustpathcase(pathname)

Return the properly cased and slashed pathname, unless running on a brain-damaged OS that is too dumb to handle pathnames in a modern, case-sensitive manner. Each path components are inspected from left to right to see if a file or directory of the same name, in any case combination, already exists. If any match results the first match is used, otherwise the original path component is used verbatim. No backtracking is performed, so if any path component in the middle fails to match an existing directory, all subsequent path components are used as-is. All backslashes are also changed to forward-slashes.

AUTHOR ^

Avatar <avatar@deva.net>, based on a prototype by Mishka Gorodnitzky <misaka@pobox.com>. Registry file support by Fulko Hew <fulko@wecan.com>.

syntax highlighting: