UpdateBuildNumber.FormatStringToBuildNumber Method

This method takes in a format string and replaces the tokens in it by their expanded values.

Namespace:  Microsoft.TeamFoundation.Build.Workflow.Activities
Assembly:  Microsoft.TeamFoundation.Build.Workflow (in Microsoft.TeamFoundation.Build.Workflow.dll)

Syntax

'Declaration
Public Shared Function FormatStringToBuildNumber ( _
    format As String, _
    buildDetail As IBuildDetail, _
    buildDefinition As IBuildDefinition, _
    designTime As Boolean _
) As String

public static string FormatStringToBuildNumber(
    string format,
    IBuildDetail buildDetail,
    IBuildDefinition buildDefinition,
    bool designTime
)

public:
static String^ FormatStringToBuildNumber(
    String^ format, 
    IBuildDetail^ buildDetail, 
    IBuildDefinition^ buildDefinition, 
    bool designTime
)

static member FormatStringToBuildNumber : 
        format:string * 
        buildDetail:IBuildDetail * 
        buildDefinition:IBuildDefinition * 
        designTime:bool -> string

public static function FormatStringToBuildNumber(
    format : String, 
    buildDetail : IBuildDetail, 
    buildDefinition : IBuildDefinition, 
    designTime : boolean
) : String

Parameters

• format
  Type: System.String

  A format string.

• buildDetail
  Type: Microsoft.TeamFoundation.Build.Client.IBuildDetail

• buildDefinition
  Type: Microsoft.TeamFoundation.Build.Client.IBuildDefinition

• designTime
  Type: System.Boolean

Return Value

Type: System.String
The build number generated by replacing the tokens in the format string.

.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.

See Also

Reference

UpdateBuildNumber Class

Microsoft.TeamFoundation.Build.Workflow.Activities Namespace