Fonctions d’API du plug-in de contrôle de code sourceSource Control Plug-in API Functions

L’API de plug-in de contrôle de code source fournit les fonctions suivantes, qui doivent être implémentées par le plug-in de contrôle de code source conformément à cette API.The Source Control Plug-in API provides the following functions, which must be implemented by the source control plug-in in accordance with this API. Les signatures de chaque fonction et la sémantique associée aux indicateurs binaires et à d’autres paramètres sont décrites en détail dans cette référence.The signatures of each function and the semantics associated with the bit flags and other parameters are described in detail in this reference.

Fonctions d’initialisation et de nettoyageInitialization and Housekeeping Functions

FonctionFunction DescriptionDescription
SccCloseProjectSccCloseProject Ferme un projet.Closes a project.
SccGetCommandOptionsSccGetCommandOptions Invite l’utilisateur à fournir des options avancées pour la commande donnée.Prompts the user for advanced options for the given command.
SccGetVersionSccGetVersion Retourne la version du plug-in de contrôle de code source.Returns the version of the source control plug-in.
SccInitializeSccInitialize Initialise le plug-in de contrôle de code source.Initializes the source control plug-in. Elle est appelée une fois pour chaque instance du plug-in.It is called once for each instance of the plug-in.
SccOpenProjectSccOpenProject Ouvre un projet.Opens a project.
SccSetOptionSccSetOption Fonction générique utilisée pour définir un large éventail d’options.A generic function used to set a wide variety of options. Chaque option commence par SCC_OPT_xxx et possède son propre ensemble de valeurs défini.Each option starts with SCC_OPT_xxx and has its own defined set of values.
SccUninitializeSccUninitialize Appelé une fois quand un plug-in de contrôle de code source doit être débranché.Called once when a source control plug-in needs to be unplugged.

Fonctions principales de contrôle de code sourceCore Source Control Functions

FonctionFunction DescriptionDescription
SccAddSccAdd Ajoute un tableau de fichiers spécifiés par des noms de chemins d’accès qualifiés complets au système de contrôle de code source.Adds an array of files specified by fully qualified path names to the source control system.
SccAddFromSccSccAddFromScc Permet à l’utilisateur de rechercher des fichiers qui se trouvent déjà dans le système de contrôle de code source, puis d’en faire partie du projet actif.Allows the user to browse for files that are already in the source control system and then make those files part of the current project.
SccCheckinSccCheckin Archive un tableau de fichiers.Checks in an array of files.
SccCheckoutSccCheckout Extrait un tableau de fichiers.Checks out an array of files.
SccDiffSccDiff Affiche les différences entre le fichier de l’utilisateur local spécifié par un nom de chemin d’accès qualifié complet et la version sous contrôle de code source.Shows the differences between the local user's file specified by a fully qualified path name and the version under source control.
SccGetSccGet Récupère une copie en lecture seule d’un ensemble de fichiers.Retrieves a read-only copy of a set of files.
SccGetEventsSccGetEvents Vérifie l’état des fichiers que l’appelant a demandés (via SccQueryInfo ).Checks the status of files that the caller has asked about (via SccQueryInfo).
SccGetProjPathSccGetProjPath Fait en sorte que le plug-in de contrôle de code source invite l’utilisateur à indiquer un chemin d’accès au projet qui est significatif pour le plug-in.Causes the source control plug-in to prompt the user for a project path that is meaningful to the plug-in.
SccHistorySccHistory Affiche l’historique d’un tableau de noms de fichiers locaux complets.Shows the history for an array of fully qualified local file names.
SccPopulateListSccPopulateList Examine la liste des fichiers pour connaître leur état actuel.Examines the list of files for their current status. En outre, utilise la pfnPopulate fonction pour notifier l’appelant lorsqu’un fichier ne correspond pas aux critères de nCommand .In addition, uses the pfnPopulate function to notify the caller when a file does not match the criteria for the nCommand.
SccPropertiesSccProperties Affiche les propriétés d’un fichier complet.Shows the properties of a fully qualified file.
SccQueryInfoSccQueryInfo Examine une liste de fichiers complets pour leur état actuel.Examines a list of fully qualified files for their current status.
SccRemoveSccRemove Supprime le tableau de fichiers qualifiés complets du système de contrôle de code source.Removes the array of fully qualified files from the source control system.
SccRenameSccRename Renomme le fichier donné avec un nouveau nom dans le système de contrôle de code source.Renames the given file to a new name in the source control system.
SccRunSccSccRunScc Accède à la gamme complète des fonctionnalités du système de contrôle de code source.Accesses the full range of features of the source control system.
SccUncheckoutSccUncheckout Annule l’extraction d’un tableau de fichiers.Undoes a checkout of an array of files.

Fonctions qui prennent en charge des fonctionnalités supplémentaires (version 1,2 de l’API de plug-in de contrôle de code source)Functions that Support Additional Capability (Version 1.2 of the Source Control Plug-in API)

Ce groupe de fonctions définit les fonctionnalités supplémentaires incluses dans la version 1,2 de l’API de plug-in de contrôle de code source.This group of functions defines the additional functionality included in version 1.2 of the Source Control Plug-in API. Ils fournissent un accès à des fonctionnalités et des fonctionnalités de contrôle de code source plus avancées.They provide access to more advanced source control features and capabilities.

FonctionFunction DescriptionDescription
SccBeginBatchSccBeginBatch Démarre une opération de traitement par lots.Starts a batch operation.
SccCreateSubProjectSccCreateSubProject Crée un sous-projet portant le nom donné sous un projet parent existant.Creates a subproject with the given name under an existing parent project.
SccDirDiffSccDirDiff Affiche les différences entre le répertoire de l’utilisateur local spécifié par un nom de chemin d’accès qualifié complet et l’emplacement de la base de données de contrôle de code source.Shows the differences between the local user's directory specified by a fully qualified path name and the source control database location.
SccDirQueryInfoSccDirQueryInfo Examine une liste de répertoires complets pour leur état actuel.Examines a list of fully qualified directories for their current status.
SccEndBatchSccEndBatch Met fin à une opération de traitement par lots.Ends a batch operation.
SccGetParentProjectPathSccGetParentProjectPath Retourne le chemin d’accès parent du projet donné (le projet doit exister).Returns parent path of the given project (the project must exist).
SccIsMultiCheckoutEnabledSccIsMultiCheckoutEnabled Vérifie si plusieurs extractions sur un fichier sont autorisées.Checks whether multiple checkouts on a file are allowed.
SccWillCreateSccFileSccWillCreateSccFile Vérifie si le plug-in va créer MSSCCPRJ. Fichiers SCC.Checks whether the plug-in will create MSSCCPRJ.SCC files.

Fonctions qui prennent en charge la fonctionnalité avancée (version 1,3 de l’API de plug-in de contrôle de code source)Functions that Support Advanced Capability (Version 1.3 of the Source Control Plug-in API)

Ce groupe de fonctions définit les fonctionnalités supplémentaires incluses dans la version 1,3 de l’API de plug-in de contrôle de code source.This group of functions defines the additional functionality included in version 1.3 of the Source Control Plug-in API. Ils fournissent un accès à des fonctionnalités et des fonctionnalités de contrôle de code source plus avancées.They provide access to more advanced source control features and capabilities.

FonctionFunction DescriptionDescription
SccAddFilesFromSCCSccAddFilesFromSCC Ajoute une liste de fichiers du contrôle de code source au projet en cours.Adds a list of files from source control to the current project.
SccBackgroundGetSccBackgroundGet Récupère une liste de fichiers du contrôle de code source sans interface utilisateur.Retrieves a list of files from source control without a user interface.
SccEnumChangedFilesSccEnumChangedFiles Récupère une liste de fichiers dans le contrôle de code source qui sont différents des fichiers locaux.Retrieves a list of files in source control that are different from the local files.
SccGetExtendedCapabilitiesSccGetExtendedCapabilities Récupère les indicateurs qui spécifient les fonctionnalités étendues prises en charge par le plug-in de contrôle de code source.Retrieves flags that specify extended capabilities supported by the source control plug-in.
SccGetUserOptionSccGetUserOption Récupère les options spécifiques à l’utilisateur.Retrieves user-specific options.
SccPopulateDirListSccPopulateDirList Examine une liste de répertoires et de fichiers dans un projet ou des projets qui sont sous contrôle de code source.Examines a list of directories and files in a project or projects that are under source control. Chaque nom de répertoire et de fichier trouvé est passé à une fonction de rappel.Each directory and file name found is passed to a callback function.
SccQueryChangesSccQueryChanges Examine les modifications de nom apportées à une liste de fichiers.Examines name changes made to a list of files. Chaque nom de fichier est passé à une fonction de rappel avec son état de modification.Each file name is passed to a callback function with its change status.

Configuration requiseRequirements

En-tête : SCC. hHeader: scc.h

(Fourni dans le dossier Common includes du kit de développement logiciel (SDK) Environment, par défaut [lecteur] \Program Files\VSIP 8.0 \ EnvSDK\common\inc ; également fourni dans le dossier VSIP avec l’exemple MSSCCI, [lecteur] \Program Files\VSIP 8.0 \ MSSCCI).(Supplied in the Environment SDK common includes folder, by default [drive] \Program Files\VSIP 8.0\EnvSDK\common\inc; also supplied in the VSIP folder with the MSSCCI sample, [drive] \Program Files\VSIP 8.0\MSSCCI).

Voir aussiSee also