{"id":5333,"date":"2005-01-22T11:46:00","date_gmt":"2005-01-22T11:46:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/buckh\/2005\/01\/22\/team-foundation-source-control-client-api-example\/"},"modified":"2005-01-22T11:46:00","modified_gmt":"2005-01-22T11:46:00","slug":"team-foundation-source-control-client-api-example","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-source-control-client-api-example\/","title":{"rendered":"Team Foundation Source Control client API example"},"content":{"rendered":"

This blog post is obsolete. Please see\u00a0https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-version-control-client-api-example-for-tfs-2010-and-newer\/<\/a><\/strong><\/p>\n

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

You’ll need to reference the following dlls to compile this example.\nSystem.dll\nMicrosoft.VisualStudio.Hatteras.Client.dll\nMicrosoft.VisualStudio.TeamFoundation.Client.dll<\/p>\n

If you write something with the API, please send me email<\/a> or leave a comment.<\/p>\n

using System;\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Text;\nusing Microsoft.VisualStudio.Hatteras.Client;\nusing Microsoft.VisualStudio.TeamFoundation.Client;<\/p>\n

namespace BasicSccExample\n{\nclass Example\n{\nstatic void Main(string[] args)\n{\n\/\/ Verify that we have the arguments we require.\nif (args.Length < 1)\n{\nConsole.Error.WriteLine(“Usage: app tfsName”);\nEnvironment.Exit(1);\n}<\/p>\n

\/\/ Get a reference to our Team Foundation Server.\nString tfsName = args[0];\nTeamFoundationServer tfs = TeamFoundationServerFactory.GetServer(tfsName);<\/p>\n

\/\/ Get a reference to Source Control.\nSourceControl sourceControl = (SourceControl) tfs.GetService(typeof(SourceControl));<\/p>\n

\/\/ Listen for the Source Control events.\nsourceControl.NonFatalError += Example.OnNonFatalError;\nsourceControl.Getting += Example.OnGetting;\nsourceControl.BeforeCheckinPendingChange += Example.OnBeforeCheckinPendingChange;\nsourceControl.NewPendingChange += Example.OnNewPendingChange;<\/p>\n

\/\/ Create a workspace.\nWorkspace workspace = sourceControl.CreateWorkspace(“BasicSccExample”, sourceControl.AuthenticatedUser);<\/p>\n

try\n{\n\/\/ Create a mapping.\nworkspace.CreateMapping(“$\/”, @”c:\\temp\\BasicSccExample”);<\/p>\n

\/\/ Get the files from the repository.\nworkspace.Get();<\/p>\n

\/\/ Create a file.\nString topDir = Path.Combine(workspace.Folders[0].LocalItem, “sub”);\nDirectory.CreateDirectory(topDir);\nString fileName = Path.Combine(topDir, “basic.cs”);\nusing (StreamWriter sw = new StreamWriter(fileName))\n{\nsw.WriteLine(“revision 1 of basic.cs”);\n}<\/p>\n

\/\/ Now add everything.\nworkspace.PendAdd(topDir, true);<\/p>\n

\/\/ Show our pending changes.\nPendingChange[] pendingChanges = workspace.GetPendingChanges();\nConsole.WriteLine(“Your current pending changes:”);\nforeach (PendingChange pendingChange in pendingChanges)\n{\nConsole.WriteLine(”\u00a0 path: ” + pendingChange.LocalItem +\n“, change: ” + PendingChange.ChangeTypeToString(pendingChange.ChangeType));\n}<\/p>\n

\/\/ Checkin the items we added.\nint changesetNumber = workspace.CheckIn(pendingChanges, “Sample changes”);\nConsole.WriteLine(“Checked in changeset ” + changesetNumber);<\/p>\n

\/\/ Checkout and modify the file.\nworkspace.PendEdit(fileName);\nusing (StreamWriter sw = new StreamWriter(fileName))\n{\nsw.WriteLine(“revision 2 of basic.cs”);\n}<\/p>\n

\/\/ Get the pending change and check in the new revision.\npendingChanges = workspace.GetPendingChanges();\nchangesetNumber = workspace.CheckIn(pendingChanges, “Modified basic.cs”);\nConsole.WriteLine(“Checked in changeset ” + changesetNumber);\n}\nfinally\n{\n\/\/ Delete the items.\nworkspace.PendDelete(“$\/*”, RecursionType.Full);\nPendingChange[] pendingChanges = workspace.GetPendingChanges();\nif (pendingChanges.Length > 0)\n{\nworkspace.CheckIn(pendingChanges, “Clean up!”);\n}<\/p>\n

\/\/ Delete the workspace.\nworkspace.Delete();\n}\n}<\/p>\n

internal static void OnNonFatalError(Object sender, ExceptionEventArgs e)\n{\nif (e.Exception != null)\n{\nConsole.Error.WriteLine(“Non-fatal exception: ” + e.Exception.Message);\n}\nelse\n{\nConsole.Error.WriteLine(“Non-fatal failure: ” + e.Failure.Message);\n}\n}<\/p>\n

internal static void OnGetting(Object sender, GettingEventArgs e)\n{\nConsole.WriteLine(“Getting: ” + e.TargetLocalItem + “, status: ” + e.Status);\n}<\/p>\n

internal static void OnBeforeCheckinPendingChange(Object sender, PendingChangeEventArgs e)\n{\nConsole.WriteLine(“Checking in ” + e.PendingChange.LocalItem);\n}<\/p>\n

internal static void OnNewPendingChange(Object sender, PendingChangeEventArgs e)\n{\nConsole.WriteLine(“Pending ” + PendingChange.ChangeTypeToString(e.PendingChange.ChangeType) +\n” on ” + e.PendingChange.LocalItem);\n}\n}\n}<\/p>\n","protected":false},"excerpt":{"rendered":"

This blog post is obsolete. Please see\u00a0https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-version-control-client-api-example-for-tfs-2010-and-newer\/ Here’s a really simple example that uses the source control API () in the Dec. CTP.\u00a0 It shows how to create a workspace, pend changes, check in those changes, and hook up some important event listeners.\u00a0 This sample doesn’t do anything useful, but it should get you going. […]<\/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,8],"class_list":["post-5333","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized","tag-source-control","tag-team-foundation"],"acf":[],"blog_post_summary":"

This blog post is obsolete. Please see\u00a0https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-version-control-client-api-example-for-tfs-2010-and-newer\/ Here’s a really simple example that uses the source control API () in the Dec. CTP.\u00a0 It shows how to create a workspace, pend changes, check in those changes, and hook up some important event listeners.\u00a0 This sample doesn’t do anything useful, but it should get you going. […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/5333","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=5333"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/5333\/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=5333"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/categories?post=5333"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/tags?post=5333"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}