NAnt SDK Documentation - v0.92

EnvironmentVariable Members

EnvironmentVariable overview

Public Instance Constructors

EnvironmentVariable Overloaded. Initializes a new instance of the EnvironmentVariable class.

Public Instance Properties

Directory The value for a directory-based environment variable. NAnt will convert it to an absolute path.
File The value for a file-based environment variable. NAnt will convert it to an absolute filename.
IfDefined 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 The literal value for the environment variable.
Name (inherited from Element) Gets the name of the XML element used to initialize this element.
NamespaceManager (inherited from Element) Gets or sets the XmlNamespaceManager.
Parent (inherited from Element) Gets or sets the parent of the element.
Path 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 Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used.
Project (inherited from Element) Gets or sets the Project to which this element belongs.
Properties (inherited from Element) Gets the properties local to this Element and the Project.
UnlessDefined 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 Gets the value of the environment variable.
VariableName The name of the environment variable.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type.
GetLocation (inherited from Element) Retrieves the location in the build file where the element is defined.
GetType (inherited from Object) Gets the Type of the current instance.
Initialize (inherited from Element)Overloaded. Performs default initialization.
Log (inherited from Element)Overloaded. Logs a message with the given priority.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Properties

CustomXmlProcessing (inherited from Element) Gets a value indicating whether the element is performing additional processing using the XmlNode that was used to initialize the element.
Location (inherited from Element) Gets or sets the location in the build file where the element is defined.
XmlNode (inherited from Element) Gets or sets the XML node of the element.

Protected Instance Methods

CopyTo (inherited from Element) Copies all instance data of the Element to a given Element.
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetAttributeConfigurationNode (inherited from Element)Overloaded. Locates the XML node for the specified attribute in the project configuration node.
Initialize (inherited from Element)Overloaded. Performs default initialization.
InitializeElement (inherited from Element)Obsolete. Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
InitializeXml (inherited from Element) Initializes all build attributes and child elements.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

EnvironmentVariable Class | NAnt.Core.Types Namespace