{"id":493,"date":"2012-03-10T08:12:38","date_gmt":"2012-03-10T08:12:38","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/buckh\/2012\/03\/10\/team-foundation-version-control-client-api-example-for-tfs-2010-and-newer\/"},"modified":"2012-03-10T08:12:38","modified_gmt":"2012-03-10T08:12:38","slug":"team-foundation-version-control-client-api-example-for-tfs-2010-and-newer","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-version-control-client-api-example-for-tfs-2010-and-newer\/","title":{"rendered":"Team Foundation Version Control client API example for TFS 2010 and newer"},"content":{"rendered":"

Over six years ago, I posted a <\/em>sample<\/em><\/a> on how to use the version control API.  The API changed in TFS 2010, but I hadn’t updated the sample.  Here is a version that works with 2010 and newer and is a little less aggressive on clean up in the finally block.<\/em><\/p>\n

This is a really simple example that uses the version control API.  It shows how to create a workspace, pend changes, check in those changes, and hook up some important event listeners.  This sample doesn’t do anything useful, but it should get you going.<\/p>\n

You have to supply a Team Project as an argument.<\/p>\n

The only real difference in this version is that it uses the TeamFoundationServer constructor (in beta 3, you were forced to use the factory class).<\/p>\n

You’ll need to add references to the following TFS assemblies to compile this example.<\/p>\n

\n

Microsoft.TeamFoundation.VersionControl.Client.dll
Microsoft.TeamFoundation.Client.dll<\/p>\n<\/blockquote>\n

\n
\n
Code Snippet<\/div>\n
\n
    \n
  1. using<\/span> System;<\/li>\n
  2. using<\/span> System.Collections.Generic;<\/li>\n
  3. using<\/span> System.Diagnostics;<\/li>\n
  4. using<\/span> System.IO;<\/li>\n
  5. using<\/span> System.Text;<\/li>\n
  6. using<\/span> Microsoft.TeamFoundation.Client;<\/li>\n
  7. using<\/span> Microsoft.TeamFoundation.VersionControl.Client;<\/li>\n
  8.  <\/li>\n
  9. namespace<\/span> BasicSccExample<\/li>\n
  10. {<\/li>\n
  11.     class<\/span> Example<\/span><\/li>\n
  12.     {<\/li>\n
  13.         static<\/span> void<\/span> Main(string<\/span>[] args)<\/li>\n
  14.         {<\/li>\n
  15.             \/\/ Verify that we have the arguments we require. <\/span><\/li>\n
  16.             if<\/span> (args.Length < 2)<\/li>\n
  17.             {<\/li>\n
  18.                 String<\/span> appName = Path<\/span>.GetFileName(Process<\/span>.GetCurrentProcess().MainModule.FileName);<\/li>\n
  19.                 Console<\/span>.Error.WriteLine(“Usage: {0} collectionURL teamProjectPath”<\/span>, appName);<\/li>\n
  20.                 Console<\/span>.Error.WriteLine(“Example: {0} http:\/\/tfsserver:8080\/tfs\/DefaultCollection $\/MyProject”<\/span>, appName);<\/li>\n
  21.                 Environment<\/span>.Exit(1);<\/li>\n
  22.             }<\/li>\n
  23.  <\/li>\n
  24.             \/\/ Get a reference to our Team Foundation Server. <\/span><\/li>\n
  25.             TfsTeamProjectCollection<\/span> tpc = new<\/span> TfsTeamProjectCollection<\/span>(new<\/span> Uri<\/span>(args[0]));<\/li>\n
  26.  <\/li>\n
  27.             \/\/ Get a reference to Version Control. <\/span><\/li>\n
  28.             VersionControlServer<\/span> versionControl = tpc.GetService<VersionControlServer<\/span>>(); <\/li>\n
  29.  <\/li>\n
  30.             \/\/ Listen for the Source Control events. <\/span><\/li>\n
  31.             versionControl.NonFatalError += Example<\/span>.OnNonFatalError;<\/li>\n
  32.             versionControl.Getting += Example<\/span>.OnGetting;<\/li>\n
  33.             versionControl.BeforeCheckinPendingChange += Example<\/span>.OnBeforeCheckinPendingChange;<\/li>\n
  34.             versionControl.NewPendingChange += Example<\/span>.OnNewPendingChange;<\/li>\n
  35.  <\/li>\n
  36.             \/\/ Create a workspace. <\/span><\/li>\n
  37.             Workspace<\/span> workspace = versionControl.CreateWorkspace(“BasicSccExample”<\/span>, versionControl.AuthorizedUser);<\/li>\n
  38.  <\/li>\n
  39.             String<\/span> topDir = null<\/span>;<\/li>\n
  40.  <\/li>\n
  41.             try<\/span><\/li>\n
  42.             {<\/li>\n
  43.                 String<\/span> localDir = @”c:\\temp\\BasicSccExample”<\/span>;<\/li>\n
  44.                 Console<\/span>.WriteLine(“\\r\\n— Create a mapping: {0} -> {1}”<\/span>, args[1], localDir); <\/li>\n
  45.                 workspace.Map(args[1], localDir);<\/li>\n
  46.  <\/li>\n
  47.                 Console<\/span>.WriteLine(“\\r\\n— Get the files from the repository.\\r\\n”<\/span>);<\/li>\n
  48.                 workspace.Get();<\/li>\n
  49.  <\/li>\n
  50.                 Console<\/span>.WriteLine(“\\r\\n— Create a file.”<\/span>);<\/li>\n
  51.                 topDir = Path<\/span>.Combine(workspace.Folders[0].LocalItem, “sub”<\/span>);<\/li>\n
  52.                 Directory<\/span>.CreateDirectory(topDir);<\/li>\n
  53.                 String<\/span> fileName = Path<\/span>.Combine(topDir, “basic.cs”<\/span>);<\/li>\n
  54.                 using<\/span> (StreamWriter<\/span> sw = new<\/span> StreamWriter<\/span>(fileName))<\/li>\n
  55.                 {<\/li>\n
  56.                     sw.WriteLine(“revision 1 of basic.cs”<\/span>);<\/li>\n
  57.                 }<\/li>\n
  58.  <\/li>\n
  59.                 Console<\/span>.WriteLine(“\\r\\n— Now add everything.\\r\\n”<\/span>);<\/li>\n
  60.                 workspace.PendAdd(topDir, true<\/span>);<\/li>\n
  61.  <\/li>\n
  62.                 Console<\/span>.WriteLine(“\\r\\n— Show our pending changes.\\r\\n”<\/span>);<\/li>\n
  63.                 PendingChange<\/span>[] pendingChanges = workspace.GetPendingChanges();<\/li>\n
  64.                 Console<\/span>.WriteLine(”  Your current pending changes:”<\/span>);<\/li>\n
  65.                 foreach<\/span> (PendingChange<\/span> pendingChange in<\/span> pendingChanges)<\/li>\n
  66.                 {<\/li>\n
  67.                     Console<\/span>.WriteLine(”    path: “<\/span> + pendingChange.LocalItem +<\/li>\n
  68.                                       “, change: “<\/span> + PendingChange<\/span>.GetLocalizedStringForChangeType(pendingChange.ChangeType));<\/li>\n
  69.                 }<\/li>\n
  70.  <\/li>\n
  71.                 Console<\/span>.WriteLine(“\\r\\n— Checkin the items we added.\\r\\n”<\/span>);<\/li>\n
  72.                 int<\/span> changesetNumber = workspace.CheckIn(pendingChanges, “Sample changes”<\/span>);<\/li>\n
  73.                 Console<\/span>.WriteLine(”  Checked in changeset “<\/span> + changesetNumber);<\/li>\n
  74.  <\/li>\n
  75.                 Console<\/span>.WriteLine(“\\r\\n— Checkout and modify the file.\\r\\n”<\/span>);<\/li>\n
  76.                 workspace.PendEdit(fileName);<\/li>\n
  77.                 using<\/span> (StreamWriter<\/span> sw = new<\/span> StreamWriter<\/span>(fileName))<\/li>\n
  78.                 {<\/li>\n
  79.                     sw.WriteLine(“revision 2 of basic.cs”<\/span>);<\/li>\n
  80.                 }<\/li>\n
  81.  <\/li>\n
  82.                 Console<\/span>.WriteLine(“\\r\\n— Get the pending change and check in the new revision.\\r\\n”<\/span>);<\/li>\n
  83.                 pendingChanges = workspace.GetPendingChanges();<\/li>\n
  84.                 changesetNumber = workspace.CheckIn(pendingChanges, “Modified basic.cs”<\/span>);<\/li>\n
  85.                 Console<\/span>.WriteLine(”  Checked in changeset “<\/span> + changesetNumber);<\/li>\n
  86.             }<\/li>\n
  87.             finally<\/span><\/li>\n
  88.             {<\/li>\n
  89.                 if<\/span> (topDir != null<\/span>)<\/li>\n
  90.                 {<\/li>\n
  91.                     Console<\/span>.WriteLine(“\\r\\n— Delete all of the items under the test project.\\r\\n”<\/span>);<\/li>\n
  92.                     workspace.PendDelete(topDir, RecursionType<\/span>.Full);<\/li>\n
  93.                     PendingChange<\/span>[] pendingChanges = workspace.GetPendingChanges();<\/li>\n
  94.                     if<\/span> (pendingChanges.Length > 0)<\/li>\n
  95.                     {<\/li>\n
  96.                         workspace.CheckIn(pendingChanges, “Clean up!”<\/span>);<\/li>\n
  97.                     }<\/li>\n
  98.  <\/li>\n
  99.                     Console<\/span>.WriteLine(“\\r\\n— Delete the workspace.”<\/span>);<\/li>\n
  100.                     workspace.Delete();<\/li>\n
  101.                 }<\/li>\n
  102.             }<\/li>\n
  103.         }<\/li>\n
  104.  <\/li>\n
  105.         internal<\/span> static<\/span> void<\/span> OnNonFatalError(Object<\/span> sender, ExceptionEventArgs<\/span> e)<\/li>\n
  106.         {<\/li>\n
  107.             if<\/span> (e.Exception != null<\/span>)<\/li>\n
  108.             {<\/li>\n
  109.                 Console<\/span>.Error.WriteLine(”  Non-fatal exception: “<\/span> + e.Exception.Message);<\/li>\n
  110.             }<\/li>\n
  111.             else<\/span><\/li>\n
  112.             {<\/li>\n
  113.                 Console<\/span>.Error.WriteLine(”  Non-fatal failure: “<\/span> + e.Failure.Message);<\/li>\n
  114.             }<\/li>\n
  115.         }<\/li>\n
  116.  <\/li>\n
  117.         internal<\/span> static<\/span> void<\/span> OnGetting(Object<\/span> sender, GettingEventArgs<\/span> e)<\/li>\n
  118.         {<\/li>\n
  119.             Console<\/span>.WriteLine(”  Getting: “<\/span> + e.TargetLocalItem + “, status: “<\/span> + e.Status);<\/li>\n
  120.         }<\/li>\n
  121.  <\/li>\n
  122.         internal<\/span> static<\/span> void<\/span> OnBeforeCheckinPendingChange(Object<\/span> sender, ProcessingChangeEventArgs<\/span> e)<\/li>\n
  123.         {<\/li>\n
  124.             Console<\/span>.WriteLine(”  Checking in “<\/span> + e.PendingChange.LocalItem);<\/li>\n
  125.         }<\/li>\n
  126.  <\/li>\n
  127.         internal<\/span> static<\/span> void<\/span> OnNewPendingChange(Object<\/span> sender, PendingChangeEventArgs<\/span> e)<\/li>\n
  128.         {<\/li>\n
  129.             Console<\/span>.WriteLine(”  Pending “<\/span> + PendingChange<\/span>.GetLocalizedStringForChangeType(e.PendingChange.ChangeType) +<\/li>\n
  130.                               ” on “<\/span> + e.PendingChange.LocalItem);<\/li>\n
  131.         }<\/li>\n
  132.     }<\/li>\n
  133. }<\/li>\n<\/ol><\/div>\n<\/p><\/div>\n<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"

    Over six years ago, I posted a sample on how to use the version control API.  The API changed in TFS 2010, but I hadn’t updated the sample.  Here is a version that works with 2010 and newer and is a little less aggressive on clean up in the finally block. This is a really […]<\/p>\n","protected":false},"author":94,"featured_media":10268,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[6,11,12,15],"class_list":["post-493","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized","tag-source-control","tag-tfs-2010","tag-tfs-2012","tag-tfs-api"],"acf":[],"blog_post_summary":"

    Over six years ago, I posted a sample on how to use the version control API.  The API changed in TFS 2010, but I hadn’t updated the sample.  Here is a version that works with 2010 and newer and is a little less aggressive on clean up in the finally block. This is a really […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/493","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/users\/94"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/comments?post=493"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/493\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/media\/10268"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/media?parent=493"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/categories?post=493"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/tags?post=493"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}