BuildStep Class

Article
2014-07-02

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Build.Tasks.Task
Microsoft.TeamFoundation.Build.Tasks.BuildStep

Namespace: Microsoft.TeamFoundation.Build.Tasks
Assembly: Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)

Syntax

'Declaration
Public Class BuildStep _
    Inherits Task

public class BuildStep : Task

public ref class BuildStep : public Task

type BuildStep =  
    class 
        inherit Task 
    end

public class BuildStep extends Task

The BuildStep type exposes the following members.

Constructors

	Name	Description
	BuildStep

Top

Properties

	Name	Description
	BuildEngine	ITask implementation—BuildEngine property. (Inherited from Task.)
	BuildUri	Property that gives the URI of the build for which this task is executing. (Overrides Task.BuildUri.)
	HostObject	ITask implementation—HostObject property. (Inherited from Task.)
	Id	The ID of the added build step. This can be used to update an existing build step with a second instance of the BuildStep task.
	Message	The message of the build step to be added. This is the text that appears in the build report.
	Name	The optional name of the build step to be added. If not specified, the message text will be used for the name also.
	Status	The status of the build step to be added. If not specified, InProgress will be used and the build step will not be marked as complete until a second invocation of the BuildStep task updates its status (using the Idoutput property).
	TeamFoundationServerUrl	Property that gives the URL of the Team Foundation Server. (Inherited from Task.)
	Tfs	Lazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	ITask implementation - Execute method. (Inherited from Task.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetParameterLog	(Inherited from Task.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LogCustomEvent	Helper to log a custom event if the task is running within MSBuild. (Inherited from Task.)
	LogError	Helper to log an error string if the task is running within MSBuild. (Inherited from Task.)
	LogErrorEvent	Helper to log an error event if the task is running within MSBuild. (Inherited from Task.)
	LogMessage(String)	Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
	LogMessage(String, MessageImportance)	Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
	LogMessageEvent	Helper to log a message event if the task is running within MSBuild. (Inherited from Task.)
	LogWarning	Helper to log a warning string if the task is running within MSBuild. (Inherited from Task.)
	LogWarningEvent	Helper to log a warning event if the task is running within MSBuild. (Inherited from Task.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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.

Share via