Surround SCM supports integration with Visual Studio. See Surround SCM Third-Party Integrations for supported versions.
This article includes information about the available integration plug-ins, installing the plug-in, selecting the plug-in, adding a solution to Surround SCM, performing Surround SCM actions, setting source control options, license usage, and troubleshooting.
About the plug-ins
Surround SCM provides two integration plug-ins for Visual Studio:
- The Surround SCM Integration Provider plug-in is built using the Visual Studio Integration Extension (VSIX) API, which allows Visual Studio to access most Surround SCM functionality. If this plug-in is used, a Surround SCM menu is added to the Visual Studio menu bar. This plug-in is supported in Visual Studio 2005 and later.
- The Surround SCM plug-in is built using the Microsoft Source Code Control Interface (MSSCCI) API, which allows Visual Studio to access a basic, limited set of Surround SCM functionality. This plug-in is supported for all supported Visual Studio versions and is the only option for Visual Studio 2003. You may also need to use this plug-in if other team members are using it or if your team uses Visual Studio integrations with other source control providers.
The following information explains how to use the Surround SCM plug-in. We recommend using the Surround SCM Integration Provider plug-in because you can access most Surround SCM functionality. See Surround SCM Visual Studio Integration. You can also switch projects that currently use the Surround SCM plug-in to use the Surround SCM Integration Provider plug-in instead. See Changing the Plug-in Used with Projects.
Installing the plug-in
The Surround SCM MSSCCI plug-in for Visual Studio is automatically installed by default with Surround SCM. See the Surround SCM installation help if you need to install Surround SCM.
Selecting the plug-in
In Visual Studio, choose Tools > Options. Select Plug-in Selection in the Source Control category and then select Surround SCM as the current source control plug-in.
Adding an existing solution to Surround SCM
Before you can access Surround SCM actions, you need to add the solution and project to Surround SCM. When you put a solution under source control, you are prompted to automatically add all projects and files.
- Open the solution and choose File > Source Control > Add Solution to Source Control. You are prompted to establish the Surround SCM association.
- Click Fix to create a repository for the project. The Surround SCM Repository Browser opens.
- Select the branch and repository to create the new repository in and click Create Repository. Surround SCM creates a single repository if the solution and the project files are in the same directory. If they are in different directories, a repository is created for each directory.
- Click OK to close the repository browser.
Performing Surround SCM actions
To perform Surround SCM actions, select the files to work with in the Solution Explorer, choose File > Source Control, and choose an action. The following actions are available.
|| Use to:
||Manually select files to retrieve local copies of to the working directory.
|Get Latest Version
||Automatically retrieve the latest version of files selected in the Solution Explorer to the working directory.
||Check out the selected files to make changes to them.
||Check in updated files and make changes available to other users.
||Update the current status of files. For example, if you check out a file from the Surround SCM Client, it is not displayed as checked out in Visual Studio until you refresh the file status.
||Compare the local copy of a file in your working directory with the current version in Surround SCM.
||View the file history.
|Surround SCM Properties
||View the file properties.
|Exclude from Source Control
||Exclude files from source control to prevent users from checking them out or in from Visual Studio. Click Advanced to destroy files and remove them from Surround SCM.
|Open from Source Control
||Open a project from Surround SCM. You can open multiple projects associated with Surround SCM at once. When prompted for your Surround SCM username and password, specify how to use the login credentials.
Always login with this username and password automatically connects to Surround SCM using the credentials each time you open an associated project.
Use login settings only for this session uses the credentials for all associated projects opened before closing Visual Studio. When you close Visual Studio, the session ends and the credentials are cleared.
Do not remember login settings always prompts for credentials when opening associated projects.
|Add Project from Source Control
||Open a project from Surround SCM and add it to the solution.
|Change Source Control
||Change the Surround SCM branch and repository associated with a solution or project. You must unbind the project or solution from source control first and then bind it to the new branch and repository. Refer to the Visual Studio documentation for more information about managing source control connections and bindings.
Setting source control options
You can configure several source control options, such as default check in options. In Visual Studio, choose Tools > Options and then select the Source Control category. Refer to the Visual Studio documentation for more information.
A Surround SCM license is used when Visual Studio needs information about a file from Surround SCM. By default, Visual Studio is set to automatically perform background status checks with source control providers. If you use floating licenses and are not performing Surround SCM actions, you can disconnect the project from Surround SCM to keep licenses available to other users. Floating licenses are automatically released after 15 minutes of inactivity.
Surround SCM is not listed as an available source control provider
Surround SCM may not be configured as an active SCM provider. Edit the registry to help Visual Studio locate Surround SCM. Open a registry editor utility, such as regedit, and check information in the following registry keys:
- HKEY_LOCAL_MACHINE/SOFTWARE/SourceCodeControlProvider—Note the value of the ProviderRegKey string. For example, Software\Seapine Software\Surround SCM\Scci.
- HKEY_LOCAL_MACHINE—Verify the SCCServerName value is Surround SCM. Verify the SCCServerPath value is C:\Program Files\Seapine\Surround SCM\Surround SCM SCCI.dll. If you installed Surround SCM in another directory, make sure the correct path is used.
Integration does not work after installing or upgrading Visual Studio
Installing or upgrading Visual Studio after installing Surround SCM deletes the registry settings required for the integration to work. Reinstall Surround SCM to update the registry. Make sure to select the option to make Surround SCM the default SCCI provider.
See Surround SCM Visual Studio Integration for additional troubleshooting information.