Source Control Plug-ins

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

The Source Control Plug-in SDK reference section contains the complete interface specification that enables source control systems to be integrated with Visual Studio. It specifies the syntax and semantics of the various functions and data types that the source control plug-in must implement to interface with the Visual Studio integrated development environment (IDE).

In This Section

• Source Control Plug-in API Functions Lists functions that must be implemented by the source control plug-in in order to comply with the Source Control Plug-in API.

• Callback Functions Implemented by the IDE Describes functions that the source control plug-in uses to pass information back to the IDE while certain commands are executed.

• Enumerators Lists the enumerator data types in the Source Control Plug-in API that the source control plug-in must know about.

• Capability Flags Describes the SCC_CAP_xxx flags, which indicate a provider's capabilities.

• Bitflags Used by Specific Commands Lists flags that are useful in the context of particular commands.

• Error Codes Lists common error values returned by functions as SCCTRN.

• Strings Used as Keys for Finding a Source Control Plug-in Describes keys for accessing the registry to find the source control plug-in.

• MSSCCPRJ.SCC File Describes a client-side file that contains information opaque to the IDE, but that is used by the source control plug-in to locate the solution or project in version control.

• Best Practices for Implementing a Source Control Plug-in Provides a collection of important technical reminders to remember while you are implementing the Source Control Plug-in API.

• Restrictions on String Lengths Describes limitations in the Source Control Plug-in API on the lengths of strings used in various functions.

• Glossary Provides helpful terms and their definitions for reading the Source Control Plug-in SDK documentation.

• How to: Turn Off Compatibility Warnings for Source Control Plug-ins Describes how to disable warnings.

Related Sections

• Source Control Plug-in Sample Provides a sample of source control plug-in functionality.

• Test Guide for Source Control Plug-ins Describes testing procedures related to a source control plug-in.

• Creating a Source Control Plug-in Discusses how to create a source control plug-in that supplies source control functionality while you are using the Visual Studio source control user interface (UI).

• Visual Studio SDK Reference Presents a list of reference topics.