This documentation is archived and is not being maintained.

Source Control VSPackage Sample

Visual Studio 2005
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

The following information explains how to use the source control sample. This sample is the "Hello, world!" for a source control VSPackage. It provides a minimal framework on which a source control VSPackage can build its own model.

Security noteSecurity Note

This sample code is provided only to illustrate a concept and should not be directly used in applications or Web sites, because it may not use the most secure coding practices. Microsoft assumes no liability for incidental or consequential damages should the sample code be used for purposes other than as intended.

To build and run the sample

  1. Locate the sample.

    The default location is <drive>:\Program Files\Visual Studio 2005 SDK\<version>\VisualStudioIntegration\Archive\VsipScc.

  2. Double-click the SccPkg solution file to open it in Visual Studio.

  3. On the Build menu, click Rebuild to build the sample and register it in the experimental hive.

  4. At the Visual Studio command prompt, type devenv.exe /setup /rootsuffix exp.

    This command merges command bars and other UI items.

  5. At the Visual Studio command prompt, type devenv.exe /rootsuffix exp.

    This command starts Visual Studio from the experimental hive.

To see the sample's functionality in the experimental build of Visual Studio

  1. On the File menu, point to New, and then click Project.

  2. In the Templates pane of the New Project dialog box, click any project, and then click OK.

  3. After the project has loaded, right-click the project or solution in Solution Explorer.

    The shortcut menu has the following new commands:

    • Add to Source Code Control

    • Checkin File

    • Checkout File

    • Undo Checkout

      Only the Add to Source Control command is initially enabled.

  4. Click Add to Source Control.

    The Checkin File and Undo Checkout commands are enabled.

  5. Click the appropriate menu buttons to check in and checkout the files in your project.


This sample demonstrates how to create a basic source control VSPackage. The source control mechanism is a primitive file-based source control. The sample shows the required elements of the VSPackage and provides a minimal implementation of the source-control functions, interfaces, and services that can be used as the basis to create a source control VSPackage.

See Also