Fonction SccBeginBatchSccBeginBatch function

Cette fonction démarre une séquence de traitement par lots des opérations de contrôle de code source.This function starts a batch sequence of source control operations. Le SccEndBatch sera appelé pour terminer le lot.The SccEndBatch will be called to end the batch. Ces lots ne peuvent pas être imbriqués.These batches may not be nested.

SyntaxeSyntax

SCCRTN SccBeginBatch(void);  

ParamètresParameters

Aucun.None.

Valeur de retourReturn value

L’implémentation de plug-in de contrôle de source de cette fonction est censée retourner l’une des valeurs suivantes :The source control plug-in implementation of this function is expected to return one of the following values:

ValueValue DescriptionDescription
SCC_OKSCC_OK Lot d’opérations a démarré avec succès.Batch of operations successfully began.
SCC_E_UNKNOWNERRORSCC_E_UNKNOWNERROR Erreur non spécifique.Nonspecific failure.

NotesRemarks

Lots de contrôle source sont utilisés pour exécuter les mêmes opérations sur plusieurs projets ou de plusieurs contextes.Source control batches are used to execute the same operations across multiple projects or multiple contexts. Lots peuvent être utilisés pour éliminer les boîtes de dialogue de projet redondante à partir de l’expérience utilisateur lors d’une opération par lot.Batches can be used to eliminate redundant per-project dialog boxes from the user experience during a batched operation. Le SccBeginBatch (fonction) et le SccEndBatch sont utilisés comme une paire de fonction pour indiquer le début et la fin d’une opération.The SccBeginBatch function and the SccEndBatch are used as a function pair to indicate the beginning and end of an operation. Ils ne peuvent pas être imbriquées.They cannot be nested. SccBeginBatch définit un indicateur qui indique qu’une opération par lot est en cours.SccBeginBatch sets a flag indicating that a batch operation is in progress.

Pendant une opération par lot est en vigueur, le plug-in de contrôle de code source doit présenter au maximum une boîte de dialogue pour toute question à l’utilisateur et s’appliquent de la réponse à partir de cette boîte de dialogue sur toutes les opérations suivantes.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.

Voir aussiSee also

Fonctions d’API source contrôle plug-in Source control plug-in API functions
SccEndBatchSccEndBatch