ToolTask.EnvironmentOverride Property

Reference

Definition

Namespace:: Microsoft.Build.Utilities

Assembly:: Microsoft.Build.Utilities.Core.dll

Assembly:: Microsoft.Build.Utilities.dll

Assemblies:: Microsoft.Build.Utilities.dll, Microsoft.Build.Utilities.v3.5.dll

Assembly:: Microsoft.Build.Utilities.v4.0.dll

Package:: Microsoft.Build.Utilities.Core v15.9.20

Package:: Microsoft.Build.Utilities.Core v16.11.0

Package:: Microsoft.Build.Utilities.Core v17.11.4

Source:: ToolTask.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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(); };

protected:
 virtual property System::Collections::Specialized::StringDictionary ^ EnvironmentOverride { System::Collections::Specialized::StringDictionary ^ get(); };

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

protected virtual System.Collections.Specialized.StringDictionary EnvironmentOverride { get; }

[System.Obsolete("Use EnvironmentVariables property")]
protected virtual System.Collections.Specialized.StringDictionary EnvironmentOverride { get; }

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

member this.EnvironmentOverride : System.Collections.Specialized.StringDictionary

[<System.Obsolete("Use EnvironmentVariables property")>]
member this.EnvironmentOverride : System.Collections.Specialized.StringDictionary

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

Protected Overridable ReadOnly Property EnvironmentOverride As StringDictionary

Property Value

Dictionary<String,String>

StringDictionary

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.

Applies to

Partilhar via