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

L’API de plug-in de contrôle de Source fournit les fonctions suivantes, qui doivent être implémentées par le plug-in conformément à cette API de contrôle de code source.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ées avec les indicateurs de bits et autres paramètres sont décrits 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.

L’initialisation et les fonctions de maintenanceInitialization and Housekeeping Functions

FonctionFunction DescriptionDescription
SccCloseProjectSccCloseProject Ferme un projet.Closes a project.
SccGetCommandOptionsSccGetCommandOptions Invite l’utilisateur pour les options avancées pour la commande donnée.Prompts the user for advanced options for the given command.
SccGetVersionSccGetVersion Retourne la version du contrôle de source de plug-in.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 Une 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 a son propre jeu défini de valeurs.Each option starts with SCC_OPT_xxx and has its own defined set of values.
SccUninitializeSccUninitialize Appelée lorsqu’un plug-in de contrôle de code source doit être déconnecté.Called once when a source control plug-in needs to be unplugged.

Fonctions de contrôle de Source de baseCore Source Control Functions

FonctionFunction DescriptionDescription
SccAddSccAdd Ajoute un tableau de fichiers spécifiés par les noms de chemin d’accès complet 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 rechercher des fichiers qui se trouvent déjà dans le système de contrôle de code source, puis rendez ces dans les fichiers du projet actuel.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 Recherche dans un tableau de fichiers.Checks in an array of files.
SccCheckoutSccCheckout Récupère un tableau de fichiers.Checks out an array of files.
SccDiffSccDiff Indique les différences entre le fichier de l’utilisateur local spécifié par un nom de chemin d’accès 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 qui a demandé à l’appelant sur (via SccQueryInfo).Checks the status of files that the caller has asked about (via SccQueryInfo).
SccGetProjPathSccGetProjPath Provoque le plug-in pour inviter l’utilisateur à un chemin d’accès de projet qui est significatif pour le plug-in de contrôle de code source.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 pour un tableau de noms de fichiers local qualifié complet.Shows the history for an array of fully qualified local file names.
SccPopulateListSccPopulateList Examine la liste des fichiers pour leur état actuel.Examines the list of files for their current status. Utilise en outre, le pfnPopulate fonction pour notifier l’appelant quand un fichier ne correspond pas les critères pour le 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 qualifié complet.Shows the properties of a fully qualified file.
SccQueryInfoSccQueryInfo Examine la liste des fichiers qualifiés 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 à partir 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é à 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 une extraction d’un tableau de fichiers.Undoes a checkout of an array of files.

Fonctions qui prennent en charge des fonctions supplémentaires (Version 1.2 de l’API de plug-in de contrôle de 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 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 indiqué sous un projet parent existant.Creates a subproject with the given name under an existing parent project.
SccDirDiffSccDirDiff Indique les différences entre le répertoire de l’utilisateur local spécifié par un nom de chemin d’accès complet et l’emplacement de 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 Termine une opération de traitement par lots.Ends a batch operation.
SccGetParentProjectPathSccGetParentProjectPath Retourne parente le chemin d’accès du projet donné (le projet doit exister).Returns parent path of the given project (the project must exist).
SccIsMultiCheckoutEnabledSccIsMultiCheckoutEnabled Vérifie si les extractions multiples sur un fichier sont autorisées.Checks whether multiple checkouts on a file are allowed.
SccWillCreateSccFileSccWillCreateSccFile Vérifie si le plug-in crée MSSCCPRJ. Fichiers de contrôle de code source.Checks whether the plug-in will create MSSCCPRJ.SCC files.

Fonctions qui prennent en charge des fonctionnalités avancées (Version 1.3 de l’API de plug-in de contrôle de 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 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 à partir du contrôle de code source pour le projet actuel.Adds a list of files from source control to the current project.
SccBackgroundGetSccBackgroundGet Récupère une liste de fichiers à partir 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 capacité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 la liste des répertoires et des fichiers dans un projet ou les 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 fichier trouvé est passé à une fonction de rappel.Each directory and file name found is passed to a callback function.
SccQueryChangesSccQueryChanges Examine les modifications apportées à une liste des fichiers aux noms.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.

SpécificationsRequirements

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

(Fourni dans le SDK de l’environnement commun inclut le dossier, par défaut [lecteur] \Program Files\VSIP 8.0\EnvSDK\common\inc ; également fourni dans le dossier VSIP avec l’exemple MSSCCI, [lecteur] \Program 8.0\MSSCCI Files\VSIP).(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

Plug-ins de contrôle de code source Source Control Plug-ins
Création d’un plug-in de contrôle de code sourceCreating a Source Control Plug-in