InformationNodeConverters.AddBuildStep Method (IBuildInformation, String, String, DateTime, BuildStepStatus)

Article
11/19/2013

Adds a top-level build step to the specified build information object. Does not save to the server.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddBuildStep ( _
    buildInformation As IBuildInformation, _
    name As String, _
    message As String, _
    time As DateTime, _
    status As BuildStepStatus _
) As IBuildStep

public static IBuildStep AddBuildStep(
    this IBuildInformation buildInformation,
    string name,
    string message,
    DateTime time,
    BuildStepStatus status
)

[ExtensionAttribute]
public:
static IBuildStep^ AddBuildStep(
    IBuildInformation^ buildInformation, 
    String^ name, 
    String^ message, 
    DateTime time, 
    BuildStepStatus status
)

static member AddBuildStep : 
        buildInformation:IBuildInformation * 
        name:string * 
        message:string * 
        time:DateTime * 
        status:BuildStepStatus -> IBuildStep

public static function AddBuildStep(
    buildInformation : IBuildInformation, 
    name : String, 
    message : String, 
    time : DateTime, 
    status : BuildStepStatus
) : IBuildStep

Parameters

buildInformation
Type: Microsoft.TeamFoundation.Build.Client.IBuildInformation

The build to which the build step will be added.

name
Type: System.String

The name of the build step to be added.

message
Type: System.String

The message of the build step to be added.

time
Type: System.DateTime

The start and finish time of the build step to be added.

status
Type: Microsoft.TeamFoundation.Build.Client.BuildStepStatus

The status of the build step to be added.

Return Value

Type: Microsoft.TeamFoundation.Build.Client.IBuildStep
The added build step instance.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IBuildInformation. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Note that build steps are no longer used after Visual Studio Application Lifecycle Management 2008 Team Foundation Server and have been replaced with various new information node types, including IBuildMessage, IBuildError, IBuildWarning, and IActivityTracking. Therefore, when you add information nodes to builds which will be primarily viewed from newer clients (for example, Team Foundation Server 2010), these new types are better than IBuildSteps.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via