Source Control Plug-in API Functions

 

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

The Source Control Plug-in API provides the following functions, which must be implemented by the source control plug-in in accordance with this API. The signatures of each function and the semantics associated with the bit flags and other parameters are described in detail in this reference.

FunctionDescription
SccCloseProjectCloses a project.
SccGetCommandOptionsPrompts the user for advanced options for the given command.
SccGetVersionReturns the version of the source control plug-in.
SccInitializeInitializes the source control plug-in. It is called once for each instance of the plug-in.
SccOpenProjectOpens a project.
SccSetOptionA generic function used to set a wide variety of options. Each option starts with SCC_OPT_xxx and has its own defined set of values.
SccUninitializeCalled once when a source control plug-in needs to be unplugged.
FunctionDescription
SccAddAdds an array of files specified by fully qualified path names to the source control system.
SccAddFromSccAllows the user to browse for files that are already in the source control system and then make those files part of the current project.
SccCheckinChecks in an array of files.
SccCheckoutChecks out an array of files.
SccDiffShows the differences between the local user's file specified by a fully qualified path name and the version under source control.
SccGetRetrieves a read-only copy of a set of files.
SccGetEventsChecks the status of files that the caller has asked about (via SccQueryInfo).
SccGetProjPathCauses the source control plug-in to prompt the user for a project path that is meaningful to the plug-in.
SccHistoryShows the history for an array of fully qualified local file names.
SccPopulateListExamines the list of files for their current status. In addition, uses the pfnPopulate function to notify the caller when a file does not match the criteria for the nCommand.
SccPropertiesShows the properties of a fully qualified file.
SccQueryInfoExamines a list of fully qualified files for their current status.
SccRemoveRemoves the array of fully qualified files from the source control system.
SccRenameRenames the given file to a new name in the source control system.
SccRunSccAccesses the full range of features of the source control system.
SccUncheckoutUndoes a checkout of an array of files.

This group of functions defines the additional functionality included in version 1.2 of the Source Control Plug-in API. They provide access to more advanced source control features and capabilities.

FunctionDescription
SccBeginBatchStarts a batch operation.
SccCreateSubProjectCreates a subproject with the given name under an existing parent project.
SccDirDiffShows the differences between the local user's directory specified by a fully qualified path name and the source control database location.
SccDirQueryInfoExamines a list of fully qualified directories for their current status.
SccEndBatchEnds a batch operation.
SccGetParentProjectPathReturns parent path of the given project (the project must exist).
SccIsMultiCheckoutEnabledChecks whether multiple checkouts on a file are allowed.
SccWillCreateSccFileChecks whether the plug-in will create MSSCCPRJ.SCC files.

This group of functions defines the additional functionality included in version 1.3 of the Source Control Plug-in API. They provide access to more advanced source control features and capabilities.

FunctionDescription
SccAddFilesFromSCCAdds a list of files from source control to the current project.
SccBackgroundGetRetrieves a list of files from source control without a user interface.
SccEnumChangedFilesRetrieves a list of files in source control that are different from the local files.
SccGetExtendedCapabilitiesRetrieves flags that specify extended capabilities supported by the source control plug-in.
SccGetUserOptionRetrieves user-specific options.
SccPopulateDirListExamines a list of directories and files in a project or projects that are under source control. Each directory and file name found is passed to a callback function.
SccQueryChangesExamines name changes made to a list of files. Each file name is passed to a callback function with its change status.

Header: scc.h

(Supplied in the Environment SDK common includes folder, by default [drive]\Program Files\VSIP 8.0\EnvSDK\common\inc; also supplied in the VSIP folder with the MSSCCI sample, [drive]\Program Files\VSIP 8.0\MSSCCI).

Source Control Plug-ins
Creating a Source Control Plug-in

Show: