SccEndBatch Function

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, use the version selector at the top left. We recommend upgrading to Visual Studio 2019. Download it here

This function concludes a batch of source control operations. These batches may not be nested.

Syntax

SCCRTN SccEndBatch(void);  

Parameters

None.

Return Value

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

Value Description
SCC_OK Batch of operations successfully concluded.
SCC_E_UNKNOWNERROR Nonspecific failure.

Remarks

Source control batches are used to execute the same source control operations across multiple projects or multiple contexts. Batches can be used to eliminate redundant dialog boxes from the user experience during a batched operation. The SccBeginBatch and the SccEndBatch function are used as a pair to indicate the beginning and end of an operation. They cannot be nested.

See Also

Source Control Plug-in API Functions
SccBeginBatch