ToolTask.EnvironmentOverride Property

Definition

Namespace:

Microsoft.Build.Utilities

Assembly:

Microsoft.Build.Utilities.Core.dll

Package:

Microsoft.Build.Utilities.Core v17.11.4

Source:

ToolTask.cs

Caution

Use EnvironmentVariables property

Gets the Path override value.

protected:
 virtual property System::Collections::Generic::Dictionary<System::String ^, System::String ^> ^ EnvironmentOverride { System::Collections::Generic::Dictionary<System::String ^, System::String ^> ^ get(); };

[System.Obsolete("Use EnvironmentVariables property")]
protected virtual System.Collections.Generic.Dictionary<string,string> EnvironmentOverride { get; }

[<System.Obsolete("Use EnvironmentVariables property")>]
member this.EnvironmentOverride : System.Collections.Generic.Dictionary<string, string>

Protected Overridable ReadOnly Property EnvironmentOverride As Dictionary(Of String, String)

Property Value

Dictionary<String,String>

The new value for the Environment for the task.

Attributes

ObsoleteAttribute

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.