Summary

Represents an environment variable.

Assembly

NAnt.Core.dll

Namespace

NAnt.Core.Types

Interfaces

IConditional

Base Types

Object
Element

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

Syntax

[Serializable()]
[ElementName("env")]
public class EnvironmentVariable : Element, IConditional

Attributes

Type	Description
SerializableAttribute
ElementNameAttribute	Indicates that class should be treated as a NAnt element.

Constructors

Name	Summary
EnvironmentVariable()	Initializes a `NAnt.Core.Types.EnvironmentVariable` instance.
EnvironmentVariable(string, string)	Initializes a `NAnt.Core.Types.EnvironmentVariable` instance with the specified name and value.

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
Directory	DirectoryInfo	The value for a directory-based environment variable. NAnt will convert it to an absolute path.
File	FileInfo	The value for a file-based environment variable. NAnt will convert it to an absolute filename.
IfDefined	bool	Indicates if the environment variable should be passed to the external program. If `true` then the environment variable will be passed; otherwise, skipped. The default is `true`.
LiteralValue	string	The literal value for the environment variable.
Location	Location	Gets or sets the location in the build file where the element is defined. Inherited from Element
Name	string	Gets the name of the XML element used to initialize this element. Inherited from Element
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
Path	PathSet	The value for a PATH like environment variable. You can use `:` or `;` as path separators and NAnt will convert it to the platform's local conventions.
PathSet	PathSet	Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used.
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
UnlessDefined	bool	Indicates if the environment variable should not be passed to the external program. If `false` then the environment variable will be passed; otherwise, skipped. The default is `false`.
Value	string	Gets the value of the environment variable.
VariableName	string	The name of the environment variable.
XmlNode	XmlNode	Gets or sets the XML node of the element. Inherited from Element

Methods