Summary

Reads a value or set of values from the Windows Registry into one or more NAnt properties.

Assembly

NAnt.Win32.dll

Namespace

NAnt.Win32.Tasks

Interfaces

IConditional

Base Types

Object
Element
Task

graph BT Type-->Base0["Task"] click Base0 "/api/NAnt.Core/Task" Base0-->Base1["Element"] click Base1 "/api/NAnt.Core/Element" Base1-->Base2["Object"] Type-.->Interface0["IConditional"] click Interface0 "/api/NAnt.Core/IConditional" Type["ReadRegistryTask"] class Type type-node

Syntax

[TaskName("readregistry")]
public class ReadRegistryTask : Task, IConditional

Examples

Read a single value from the registry.

<readregistry property="sdkRoot" key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot" hive="LocalMachine" />

Read all the registry values in a key.

<readregistry prefix="dotNetFX" key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot" hive="LocalMachine" />

Attributes

Type	Description
TaskNameAttribute	Indicates that class should be treated as a task.

Properties

Name	Value	Summary
CustomXmlProcessing	bool	Gets a value indicating whether the element is performing additional processing using the `NAnt.Core.Element.XmlNode` that was used to initialize the element. Inherited from Element
FailOnError	bool	Determines if task failure stops the build, or is just reported. The default is `true`. Inherited from Task
IfDefined	bool	If `true` then the task will be executed; otherwise, skipped. The default is `true`. Inherited from Task
Location	Location	Gets or sets the location in the build file where the element is defined. Inherited from Element
LogPrefix	string	The prefix used when sending messages to the log. Inherited from Task
Name	string	The name of the task. Inherited from Task
NamespaceManager	XmlNamespaceManager	Gets or sets the `System.Xml.XmlNamespaceManager`. Inherited from Element
Parent	Object	Gets or sets the parent of the element. Inherited from Element
Project	Project	Gets or sets the `NAnt.Core.Element.Project` to which this element belongs. Inherited from Element
Properties	PropertyDictionary	Gets the properties local to this `NAnt.Core.Element` and the `NAnt.Core.Element.Project`. Inherited from Element
PropertyName	string	The property to set to the specified registry key value. If this attribute is used then a single value will be read.
PropertyPrefix	string	The prefix to use for the specified registry key values. If this attribute is used then all registry values will be read and stored as properties with this prefix.
RegistryHiveName	string	Space separated list of registry hives to search for `NAnt.Win32.Tasks.ReadRegistryTask.RegistryKey`. For a list of possible values, see `Microsoft.Win32.RegistryHive`. The default is `Microsoft.Win32.RegistryHive.LocalMachine`.
RegistryKey	string	The registry key to read, including the path.
Threshold	Level	Gets or sets the log threshold for this `NAnt.Core.Task`. By default the threshold of a task is `NAnt.Core.Level.Debug`, causing no messages to be filtered in the task itself. Inherited from Task
UnlessDefined	bool	Opposite of `NAnt.Core.Task.IfDefined`. If `false` then the task will be executed; otherwise, skipped. The default is `false`. Inherited from Task
Verbose	bool	Determines whether the task should report detailed build log messages. The default is `false`. Inherited from Task
XmlNode	XmlNode	Gets or sets the XML node of the element. Inherited from Element

Methods