SccCloseProject Function

  • Article

Note

This article applies to Visual Studio 2015. 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 closes a project, marking the end of a particular session.

Syntax

SCCRTN SccCloseProject (  
   LPVOID pvContext  
);

Parameters

pvContext
The source control plug-in context structure.

Return Value

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

Value Description
SCC_OK The project was successfully closed.
SCC_E_PROJNOTOPEN No project is currently open.
SCC_E_NOTAUTHORIZED The user is not allowed to perform this operation.
SCC_E_NONSPECIFICERROR Nonspecific failure.

Remarks

The SccOpenProject is always called before this function. A call to this function is then followed by a call to either the SccOpenProject function or the SccUninitialize, which ends the connection to the source control system completely.

See Also

Source Control Plug-in API Functions
SccOpenProject
SccInitialize