Share via


BuildCommonUtil Class

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Common.BuildCommonUtil

Namespace:  Microsoft.TeamFoundation.Build.Common
Assembly:  Microsoft.TeamFoundation.Build.Common (in Microsoft.TeamFoundation.Build.Common.dll)

Syntax

'Declaration
Public NotInheritable Class BuildCommonUtil
public static class BuildCommonUtil
public ref class BuildCommonUtil abstract sealed
[<AbstractClass>]
[<Sealed>]
type BuildCommonUtil =  class end
public final class BuildCommonUtil

The BuildCommonUtil type exposes the following members.

Properties

  Name Description
Public propertyStatic member BuildAgentIdVariable Gets the variable to use when referencing the build agent ID in an agent's BuildDirectory property.
Public propertyStatic member BuildAgentNameVariable Gets the variable to use when referencing the build agent name in an agent's BuildDirectory property.
Public propertyStatic member BuildDefinitionIdVariable Gets the variable to use when referencing the build definition ID in an agent's BuildDirectory property.
Public propertyStatic member BuildDefinitionPathVariable Gets the variable to use when referencing the build definition path in an agent's BuildDirectory property.
Public propertyStatic member BuildDirEnvironmentVariable Gets the environment variable to use when referencing the build directory on a given agent.
Public propertyStatic member BuildRegistryKeyPath Gets the registry key path where build-specific settings should be stored.
Public propertyStatic member DefaultAgentPort Gets the default port for build agents.
Public propertyStatic member DefaultHostedWorkingDirectory Gets the default working directory for hosted build agents.
Public propertyStatic member DefaultWorkingDirectory Gets the default working directory for build agents.
Public propertyStatic member MacroPattern
Public propertyStatic member NoCICheckInComment Gets the comment that should be included in the check-in comment to make sure that CI ignores the changeset
Public propertyStatic member SourceDirEnvironmentVariable Gets the sources directory, into which all source files are mapped by default. This is equivalent to BuildDirEnvironmentVariable\SourceSubdirectory.

Top

Methods

  Name Description
Public methodStatic member ExpandEnvironmentVariables(String) Expands environment variables which are of the format '$(...)' where the '...' part of the string is any valid combination of letters and numbers. Any patterns recognized as environment variables which do not expand to an existing variable in the current environment are left as-is in the output path.
Public methodStatic member ExpandEnvironmentVariables(String, IDictionary<String, String>) Expands environment variables which are of the format '$(...)' where the '...' part of the string is any valid combination of letters and numbers. Any patterns recognized as environment variables which do not expand to an existing variable in the current environment are matched with the keys in the string dictionary and replaced with the dictionaries value. If a pattern does not match an environment variable or a key in the dictionary it is left as-is in the output path.
Public methodStatic member GetCommonLocalPath Determines the longest common root path between all provided items.
Public methodStatic member GetCommonServerPath Determines the longest common root path between all provided items.
Public methodStatic member Replace Performs a string replacement.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Common Namespace