{"id":3893,"date":"2006-05-01T21:28:00","date_gmt":"2006-05-01T21:28:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/buckh\/2006\/05\/01\/compare-the-content-changes-in-a-shelveset-with-any-checked-in-version\/"},"modified":"2006-05-01T21:28:00","modified_gmt":"2006-05-01T21:28:00","slug":"compare-the-content-changes-in-a-shelveset-with-any-checked-in-version","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/buckh\/compare-the-content-changes-in-a-shelveset-with-any-checked-in-version\/","title":{"rendered":"Compare the content changes in a shelveset with any checked-in version"},"content":{"rendered":"

I wrote this snippet recently to compare the edited files in a shelveset with an arbitrary checked-in version of the same files.  It’s another example of how to use the API to show differences.  See How to compare (diff) trees at different versions using the API<\/a> for a different example of comparing checked-in files.<\/p>\n

If you are just getting started with the version control API, you’ll want to start with the basic example<\/font><\/a>.<\/p>\n

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

namespace<\/span> DiffShelveset
{
    class<\/span> Program
    {
        static<\/span> void<\/span> Main(string<\/span>[] args)
        {
            if<\/span> (args.Length != 2<\/span>)
            {
                Console.Error.WriteLine(“This command shows the differences between the shelved edits”<\/span>);
                Console.Error.WriteLine(“and the specified version of the same files.”<\/span>);
                Console.Error.WriteLine(”  Usage: diffshelveset shelvset[;shelvesetOwner] versionSpec”<\/span>);
                Console.Error.WriteLine(”  Example: diffshelveset BugFix;Alice C123″<\/span>);
                Environment.Exit(1<\/span>);
            } <\/p>\n

            \/\/ Determine the server by using the local workspace cache.<\/span>
            WorkspaceInfo wsInfo = Workstation.Current.GetLocalWorkspaceInfo(Environment.CurrentDirectory);
            if<\/span> (wsInfo == null<\/span>)
            {
                Console.Error.WriteLine(“The current directory is not part of a workspace.”<\/span>);
                Environment.Exit(1<\/span>);
            } <\/p>\n

            TeamFoundationServer tfs = new<\/span> TeamFoundationServer(wsInfo.ServerUri.AbsoluteUri);
            VersionControlServer versionControl = (VersionControlServer) tfs.GetService(typeof<\/span>(VersionControlServer)); <\/p>\n

            try<\/span>
            {
                DiffShelvedChanges(versionControl, args[0<\/span>], args[1<\/span>]);
            }
            catch<\/span> (VersionControlException e)
            {
                Console.Error.WriteLine(e.Message);
                Environment.Exit(1<\/span>);
            }
        } <\/p>\n

        static<\/span> void<\/span> DiffShelvedChanges(VersionControlServer versionControl,
                                       String shevlesetArg, String versionArg)
        {
            \/\/ A TeamFoundationServer object is always the “parent” of a VersionControlServer<\/span>
            \/\/ object.<\/span>
            TeamFoundationServer tfs = versionControl.TeamFoundationServer; <\/p>\n

            \/\/ The shelvesetName;shelvesetOwner format is exactly the same as<\/span>
            \/\/ workspaceName;workspaceOwner, so the same class is used for parsing both.<\/span>
            String shelvesetName, shelvesetOwner;
            WorkspaceSpec.Parse(shevlesetArg, RepositoryConstants.AuthenticatedUser,
                                out<\/span> shelvesetName, out<\/span> shelvesetOwner); <\/p>\n

            \/\/ To improve performance, the PendingChange objects do not normally contain the URLs for<\/span>
            \/\/ downloading the file content.  In this case, we know that we are going to be downloading<\/span>
            \/\/ the file contents, so we set the last parameter to true.  Since we want all changes in<\/span>
            \/\/ the shelveset, we specify null for the ItemSpecs.<\/span>
            PendingSet[] pendingSets = versionControl.QueryShelvedChanges(shelvesetName, shelvesetOwner,
                                                                          null<\/span>, true<\/span>);
            if<\/span> (pendingSets.Length == 0<\/span>)
            {
                Console.Error.WriteLine(“No shelveset matched.”<\/span>);
                Environment.Exit(1<\/span>);
            }
            else<\/span> if<\/span> (pendingSets.Length > 1<\/span>)
            {
                Console.Error.WriteLine(“More than one shelveset matched.”<\/span>);
                Environment.Exit(1<\/span>);
            } <\/p>\n

            PendingChange[] shelvedChanges = pendingSets[0<\/span>].PendingChanges;
            if<\/span> (shelvedChanges.Length == 0<\/span>)
            {
                Console.Error.WriteLine(“You don’t have permission to any of the files involved.”<\/span>);
                Environment.Exit(1<\/span>);
            } <\/p>\n

            \/\/ Convert the string argument into a ChangesetVersionSpec, LabelVersionSpec, DateVersionSpec,<\/span>
            \/\/ or WorkspaceVersionSpec (all derive from the abstract VersionSpec class).<\/span>
            VersionSpec versionSpec = VersionSpec.ParseSingleSpec(versionArg,
                                                                  RepositoryConstants.AuthenticatedUser); <\/p>\n

            \/\/ Now we can diff each change against the version specified.<\/span>
            foreach<\/span> (PendingChange shelvedChange in<\/span> shelvedChanges)
            {
                \/\/ We only want files that are being edited, but there’s nothing to diff if <\/span>
                \/\/ the file is guaranteed not to exist at a different version.<\/span>
                if<\/span> (shelvedChange.ItemType != ItemType.File ||
                    !shelvedChange.IsEdit || shelvedChange.IsAdd || shelvedChange.IsBranch)
                {
                    continue<\/span>;
                } <\/p>\n

                DiffItemShelvedChange diffChange = new<\/span> DiffItemShelvedChange(shelvesetName,
                                                                             shelvedChange); <\/p>\n

                \/\/ We could have directly created a DiffItemVersionedFile, however it wouldn’t<\/span>
                \/\/ take into account the fact that the file may have had a different name.<\/span>
                \/\/ The CreateTargetDiffItem() will take care of all the arcane details, whereas<\/span>
                \/\/ the constructor assumes you are specifying exactly what you want.<\/span>
                IDiffItem diffVersion = Difference.CreateTargetDiffItem(versionControl,
                                                                        shelvedChange,
                                                                        versionSpec); <\/p>\n

                \/\/ Since the VisualDiff*() methods do not block, we call the more specific<\/span>
                \/\/ method so that we can have the call block until the external tool exits.<\/span>
                \/\/ If you want to see an example of producing textual diff output instead,<\/span>
                \/\/ see the diff call in<\/span>
                \/\/ http:\/\/blogs.msdn.com\/buckh\/archive\/2006\/04\/06\/project_diff.aspx.<\/span>
                DiffOptions diffOpts = new<\/span> DiffOptions();
                diffOpts.UseThirdPartyTool = true<\/span>;
                Difference.DiffFiles(versionControl, diffVersion, diffChange, diffOpts,
                                     String.Empty, true<\/span>);
            }
        }
    }
}
<\/div><\/p>\n","protected":false},"excerpt":{"rendered":"

I wrote this snippet recently to compare the edited files in a shelveset with an arbitrary checked-in version of the same files.  It’s another example of how to use the API to show differences.  See How to compare (diff) trees at different versions using the API for a different example of comparing checked-in files. If […]<\/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-3893","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":"

I wrote this snippet recently to compare the edited files in a shelveset with an arbitrary checked-in version of the same files.  It’s another example of how to use the API to show differences.  See How to compare (diff) trees at different versions using the API for a different example of comparing checked-in files. If […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/3893","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=3893"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/posts\/3893\/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=3893"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/categories?post=3893"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/buckh\/wp-json\/wp\/v2\/tags?post=3893"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}