IProcessTemplates.AddUpdateTemplate method (String, String, String, String, String)

  • Article

TFS 2018 | TFS 2017 | TFS 2015 | Previous versions

Add or update a process template with the given properties.

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

Syntax

C#

 void AddUpdateTemplate(
string name,
string description,
string metadata,
string state,
string zipFileName
)

C++

 void AddUpdateTemplate(
String^ name,
String^ description,
String^ metadata,
String^ state,
String^ zipFileName
)

F#

 abstract AddUpdateTemplate :
name:string *
description:string *
metadata:string *
state:string *
zipFileName:string -> unit

VB

 'Sub AddUpdateTemplate (
name As String,
description As String,
metadata As String,
state As String,
zipFileName As String
)

Parameters

name

     Type: System.String
     This value is no longer used and will be ignored

description

     Type: System.String
     This value is no longer used and will be ignored

metadata

     Type: System.String
     This value is no longer used and will be ignored

state

     Type: System.String
     This value is no longer used and will be ignored

zipFileName

     Type: System.String
     The name of the zip file that contains the process template resources

Remarks

Change in API Behavior for TFS 2015

API values for the name, description and metadata arguments are now overridden by the process template data specified in the zipFileName. This change was required to avoid conflicts between the ZIP file contents and parameters passed through the API.

These properties are defined in the ProcessTemplate.xml file.

<?xml version="1.0" encoding="utf-8"?>  
<ProcessTemplate>    
  <metadata>   
    <name>Agile</name>   
    <description>This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.</description>  
    <version type="ADCC42AB-9882-485E-A3ED-7678F01F66BC" major="14" minor="1" />    
    <plugins>    
      . . .   
   </plugins>    
  </metadata>   
  <groups>

IProcessTemplates Interface
Microsoft.TeamFoundation.Server Namespace