SccBeginBatch Function

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at SccBeginBatch Function.

This function starts a batch sequence of source control operations. The SccEndBatch will be called to end the batch. These batches may not be nested.

SCCRTN SccBeginBatch(void);  

Parameters

None.

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

ValueDescription
SCC_OKBatch of operations successfully began.
SCC_E_UNKNOWNERRORNonspecific failure.

Source control batches are used to execute the same operations across multiple projects or multiple contexts. Batches can be used to eliminate redundant per-project dialog boxes from the user experience during a batched operation. The SccBeginBatch function and the SccEndBatch are used as a function pair to indicate the beginning and end of an operation. They cannot be nested. SccBeginBatch sets a flag indicating that a batch operation is in progress.

While a batch operation is in effect, the source control plug-in should present at most one dialog box for any question to the user and apply the response from that dialog box on all subsequent operations.

Source Control Plug-in API Functions
SccEndBatch

Show: