ToolTask.EnvironmentOverride ToolTask.EnvironmentOverride ToolTask.EnvironmentOverride ToolTask.EnvironmentOverride Property

Definition

Warning

This API is now obsolete.

Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool.

protected:
 virtual property System::Collections::Specialized::StringDictionary ^ EnvironmentOverride { System::Collections::Specialized::StringDictionary ^ get(); };
[System.Obsolete("Use EnvironmentVariables property")]
protected virtual System.Collections.Specialized.StringDictionary EnvironmentOverride { get; }
member this.EnvironmentOverride : System.Collections.Specialized.StringDictionary
Protected Overridable ReadOnly Property EnvironmentOverride As StringDictionary

Property Value

A set of environment variables. Each dictionary key is the name of the environment variable to override, and the dictionary value is the value to set for that environment variable. The default implementation of EnvironmentOverride returns null.

Examples

using System;  
using Microsoft.Build.Utilities;  
using System.Collections.Specialized;  

/// <summary>  
/// CustomToolTask overrides the EnvironmentOverride property of ToolTask to add a directory  
/// to the Path environment variable of the process being executed  
/// </summary>  
abstract class CustomToolTask : ToolTask  
{  
      protected override StringDictionary EnvironmentOverride  
      {  
            get  
            {  
                  string newPath = Environment.GetEnvironmentVariable("Path", EnvironmentVariableTarget.Process) + @";C:\MyDirectory";  
                  StringDictionary result = new StringDictionary();  
                  result.Add("Path", newPath);  
                  return result;  
            }  
      }  
}  

Remarks

The ExecuteTool method passes these environment variables to the StartInfo of the process in which the tool executes. Any environment variables not included in the EnvironmentOverride dictionary are inherited from the process in which the ExecuteTool method executes.

Applies to