Class Poco::Util::WinRegistryConfiguration
Author: Applied Informatics Software Engineering GmbH and Contributors

# Poco::Util

# class WinRegistryConfiguration

Library: Util
Package: Windows
Header: Poco/Util/WinRegistryConfiguration.h

## Description

An implementation of AbstractConfiguration that stores configuration data in the Windows registry.

Removing key is not supported. An attempt to remove a key results in a NotImplementedException being thrown.

## Inheritance

Direct Base Classes: AbstractConfiguration

All Base Classes: Poco::RefCountedObject, AbstractConfiguration

## Member Summary

Member Functions: convertToRegFormat, enumerate, getRaw, removeRaw, setRaw

Inherited Functions: createView, duplicate, enableEvents, enumerate, eventsEnabled, expand, getBool, getDouble, getInt, getInt64, getRaw, getRawString, getString, getUInt, getUInt64, has, hasOption, hasProperty, keys, parseBool, parseInt, parseInt64, parseUInt, parseUInt64, referenceCount, release, remove, removeRaw, setBool, setDouble, setInt, setInt64, setRaw, setRawWithEvent, setString, setUInt, setUInt64

## Constructors

### WinRegistryConfiguration

WinRegistryConfiguration(
const std::string & rootPath,
REGSAM extraSam = 0
);

Creates the WinRegistryConfiguration. The rootPath must start with one of the root key names like HKEY_CLASSES_ROOT, e.g. HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services. All further keys are relativ to the root path and can be dot seperated, e.g. the path MyService.ServiceName will be converted to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\MyService\ServiceName. The extraSam parameter will be passed along to WinRegistryKey, to control registry virtualization for example.

## Destructor

### ~WinRegistryConfiguration

~WinRegistryConfiguration();

Destroys the WinRegistryConfiguration.

## Member Functions

### convertToRegFormat

std::string convertToRegFormat(
const std::string & key,
std::string & keyName
) const;

Takes a key in the format of A.B.C and converts it to registry format A\B\C, the last entry is the keyName, the rest is returned as path

### enumerate

void enumerate(
const std::string & key,
Keys & range
) const;

See also: Poco::Util::AbstractConfiguration::enumerate()

### getRaw

bool getRaw(
const std::string & key,
std::string & value
) const;

See also: Poco::Util::AbstractConfiguration::getRaw()

### removeRaw

void removeRaw(
const std::string & key
);

See also: Poco::Util::AbstractConfiguration::removeRaw()

### setRaw

void setRaw(
const std::string & key,
const std::string & value
);

See also: Poco::Util::AbstractConfiguration::setRaw()