Share via

SccWillCreateSccFile Function

  • Article

Applies to: yesVisual Studio noVisual 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

This function determines whether the source control plug-in supports the creation of the MSSCCPRJ.SCC file for each of the given files.

Syntax

SCCRTN SccWillCreateSccFile(
   LPVOID  pContext,
   LONG    nFiles,
   LPCSTR* lpFileNames,
   LPBOOL  pbSccFiles
);

Parameters

pContext

[in] The source control plug-in context pointer.

nFiles

[in] The number of file names included in the lpFileNames array as well as the length of the pbSccFiles array.

lpFileNames

[in] An array of fully qualified file names to check (array must be allocated by caller).

pbSccFiles

[in, out] Array in which to store the results.

Return Value

The source control plug-in implementation of this function is expected to return one of the following values:

Value Description
SCC_OK Success.
SCC_E_INVALIDFILEPATH One of the paths in the array is invalid.
SCC_E_NONSPECIFICERROR Nonspecific failure.

Remarks

This function is called with a list of files to determine if the source control plug-in provides support in the MSSCCPRJ.SCC file for each of the given files (for more information on the MSSCCPRJ.SCC file, see MSSCCPRJ.SCC File). Source control plug-ins can declare whether they have the capability of creating MSSCCPRJ.SCC files by declaring SCC_CAP_SCCFILE during initialization. The plug-in returns TRUE or FALSE per file in the pbSccFiles array to indicate which of the given files have MSSCCPRJ.SCC support. If the plug-in returns a success code from the function, the values in the return array are honored. On failure, the array is ignored.

See also