{"id":4123,"date":"2006-03-15T17:17:00","date_gmt":"2006-03-15T17:17:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/buckh\/2006\/03\/15\/team-foundation-version-control-client-api-example-rtm-version\/"},"modified":"2006-03-15T17:17:00","modified_gmt":"2006-03-15T17:17:00","slug":"team-foundation-version-control-client-api-example-rtm-version","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/buckh\/team-foundation-version-control-client-api-example-rtm-version\/","title":{"rendered":"Team Foundation Version Control client API example (RTM version)"},"content":{"rendered":"

[Update 3\/10\/2012] <\/strong>If you are using TFS 2010 or newer, there is an updated version control client API example<\/a>.<\/em><\/p>\n

[Update 6\/13\/06]<\/strong> While the documentation is not what it needs to be, you can find reference-style documentation on a significant amount of the API in the VS SDK (current release is April): <\/em>http:\/\/blogs.msdn.com\/buckh\/archive\/2005\/12\/09\/502179.aspx<\/em><\/a>.<\/em><\/p>\n

I’ve updated this sample a few times before<\/a>.  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.  Note that it deletes everything under the specified Team Project, so don’t use this on a Team Project or server you care about.<\/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 reference the following dlls to compile this example.<\/p>\n

\n

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

using<\/span> System;
using<\/span> System.Collections.Generic;
using<\/span> System.Diagnostics;
using<\/span> System.IO;
using<\/span> System.Text;
using<\/span> Microsoft.TeamFoundation.Client;
using<\/span> Microsoft.TeamFoundation.VersionControl.Client; <\/p>\n

namespace<\/span> BasicSccExample
{
    class<\/span> Example
    {
        static<\/span> void<\/span> Main(string<\/span>[] args)
        {
            \/\/ Verify that we have the arguments we require.<\/span>
            if<\/span> (args.Length < 2<\/span>)
            {
                String appName = Path.GetFileName(Process.GetCurrentProcess().MainModule.FileName);
                Console.Error.WriteLine(“Usage: {0} tfsServerName tfsTeamProjectPath”<\/span>, appName);
                Console.Error.WriteLine(“Example: {0} http:\/\/tfsserver:8080 $\/MyProject”<\/span>, appName);
                Environment.Exit(1<\/span>);
            } <\/p>\n

            \/\/ Get a reference to our Team Foundation Server.<\/span>
            String tfsName = args[0<\/span>];
            TeamFoundationServer tfs = new<\/span> TeamFoundationServer(tfsName); <\/p>\n

            \/\/ Get a reference to Version Control.<\/span>
            VersionControlServer versionControl = (VersionControlServer) tfs.GetService(typeof<\/span>(VersionControlServer)); <\/p>\n

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

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

            try<\/span>
            {
                \/\/ Create a mapping using the Team Project supplied on the command line.<\/span>
                workspace.Map(args[1<\/span>], @”c:tempBasicSccExample”<\/span>); <\/p>\n

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

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

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

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

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

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

                \/\/ Get the pending change and check in the new revision.<\/span>
                pendingChanges = workspace.GetPendingChanges();
                changesetNumber = workspace.CheckIn(pendingChanges, “Modified basic.cs”<\/span>);
                Console.WriteLine(“Checked in changeset “<\/span> + changesetNumber);
            }
            finally<\/span>
            {
                \/\/ Delete all of the items under the test project.<\/span>
                workspace.PendDelete(args[1<\/span>], RecursionType.Full);
                PendingChange[] pendingChanges = workspace.GetPendingChanges();
                if<\/span> (pendingChanges.Length > 0<\/span>)
                {
                    workspace.CheckIn(pendingChanges, “Clean up!”<\/span>);
                } <\/p>\n

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

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

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

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

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

[Update 3\/10\/2012] If you are using TFS 2010 or newer, there is an updated version control client API example. [Update 6\/13\/06] While the documentation is not what it needs to be, you can find reference-style documentation on a significant amount of the API in the VS SDK (current release is April): http:\/\/blogs.msdn.com\/buckh\/archive\/2005\/12\/09\/502179.aspx. I’ve updated this […]<\/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,15],"class_list":["post-4123","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized","tag-source-control","tag-team-foundation","tag-tfs-api"],"acf":[],"blog_post_summary":"

[Update 3\/10\/2012] If you are using TFS 2010 or newer, there is an updated version control client API example. [Update 6\/13\/06] While the documentation is not what it needs to be, you can find reference-style documentation on a significant amount of the API in the VS SDK (current release is April): http:\/\/blogs.msdn.com\/buckh\/archive\/2005\/12\/09\/502179.aspx. I’ve updated this […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/4123","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=4123"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/4123\/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=4123"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/categories?post=4123"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/tags?post=4123"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}