Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

SccBeginBatch Function

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

This function starts a batch sequence of source control operations. The SccEndBatch Function 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:

Value Description

SCC_OK

Batch of operations successfully began.

SCC_E_UNKNOWNERROR

Nonspecific 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 Function 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.

Community Additions

ADD
Show:
© 2015 Microsoft