Partager via


Fonctions d’API du plug-in de contrôle de code source

L’API 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. Les signatures de chaque fonction et de la sémantique associées aux indicateurs de bits et autres paramètres sont décrites en détail dans cette référence.

Fonctions d’initialisation et de nettoyage

Fonction Description
SccCloseProject Ferme un projet.
SccGetCommandOptions Invite l’utilisateur à entrer des options avancées pour la commande donnée.
SccGetVersion Retourne la version du plug-in de contrôle de code source.
SccInitialize Initialise le plug-in de contrôle de code source. Elle est appelée une fois pour chaque instance du plug-in.
SccOpenProject Ouvre un projet.
SccSetOption Fonction générique utilisée pour définir une grande variété d’options. Chaque option commence par SCC_OPT_xxx et possède son propre jeu de valeurs défini.
SccUninitialize Appelé une fois lorsqu’un plug-in de contrôle de code source doit être déconnecté.

Principales fonctions de contrôle de code source

Fonction Description
SccAdd Ajoute un tableau de fichiers spécifiés par des noms de chemin d’accès complets au système de contrôle de code source.
SccAddFromScc Permet à l’utilisateur de rechercher des fichiers déjà présents dans le système de contrôle de code source, puis de les rendre dans le projet actuel.
SccCheckin Vérifie dans un tableau de fichiers.
SccCheckout Extrait un tableau de fichiers.
SccDiff Affiche les différences entre le fichier de l’utilisateur local spécifié par un nom de chemin complet et la version sous contrôle de code source.
SccGet Récupère une copie en lecture seule d’un ensemble de fichiers.
SccGetEvents Vérifie l’état des fichiers que l’appelant a demandé (via SccQueryInfo).
SccGetProjPath Provoque le plug-in de contrôle de code source à inviter l’utilisateur à entrer un chemin d’accès de projet significatif au plug-in.
SccHistory Affiche l’historique d’un tableau de noms de fichiers locaux complets.
SccPopulateList Examine la liste des fichiers pour leur état actuel. En outre, utilise la pfnPopulate fonction pour notifier l’appelant lorsqu’un fichier ne correspond pas aux critères du nCommand.
SccProperties Affiche les propriétés d’un fichier complet.
SccQueryInfo Examine la liste des fichiers qualifiés complets pour leur état actuel.
SccRemove Supprime le tableau de fichiers qualifiés complets du système de contrôle de code source.
SccRename Renomme le fichier donné en un nouveau nom dans le système de contrôle de code source.
SccRunScc Accède à la gamme complète de fonctionnalités du système de contrôle de code source.
SccUncheckout Annule un case activée out d’un tableau de fichiers.

Fonctions qui prennent en charge des fonctionnalités supplémentaires (version 1.2 de l’API plug-in de contrôle de code source)

Ce groupe de fonctions définit les fonctionnalités supplémentaires incluses dans la version 1.2 de l’API plug-in de contrôle de code source. Ils fournissent un accès aux fonctionnalités et fonctionnalités de contrôle de code source plus avancées.

Fonction Description
SccBeginBatch Démarre une opération de traitement par lots.
SccCreateSubProject Crée un sous-projet avec le nom donné sous un projet parent existant.
SccDirDiff Affiche les différences entre le répertoire de l’utilisateur local spécifié par un nom de chemin complet et l’emplacement de la base de données de contrôle de code source.
SccDirQueryInfo Examine la liste des répertoires qualifiés complets pour leur état actuel.
SccEndBatch Termine une opération de traitement par lots.
SccGetParentProjectPath Retourne le chemin parent du projet donné (le projet doit exister).
SccIsMultiCheckoutEnabled Vérifie si plusieurs case activée outs sur un fichier sont autorisés.
SccWillCreateSccFile Vérifie si le plug-in crée MSS RUNTIMEJ. Fichiers SCC.

Fonctions qui prennent en charge la fonctionnalité avancée (version 1.3 de l’API de plug-in de contrôle de code source)

Ce groupe de fonctions définit les fonctionnalités supplémentaires incluses dans la version 1.3 de l’API plug-in de contrôle de code source. Ils fournissent un accès aux fonctionnalités et fonctionnalités de contrôle de code source plus avancées.

Fonction Description
SccAddFilesFromSCC Ajoute une liste de fichiers du contrôle de code source au projet actuel.
SccBackgroundGet Récupère une liste de fichiers à partir du contrôle de code source sans interface utilisateur.
SccEnumChangedFiles Récupère une liste de fichiers dans le contrôle de code source qui sont différents des fichiers locaux.
SccGetExtendedCapabilities Récupère des indicateurs qui spécifient des fonctionnalités étendues prises en charge par le plug-in de contrôle de code source.
SccGetUserOption Récupère les options spécifiques à l’utilisateur.
SccPopulateDirList Examine une liste de répertoires et de fichiers dans un projet ou des projets qui sont sous contrôle de code source. Chaque répertoire et nom de fichier trouvés est transmis à une fonction de rappel.
SccQueryChanges Examine les modifications apportées au nom dans une liste de fichiers. Chaque nom de fichier est transmis à une fonction de rappel avec son état de modification.

Spécifications

En-tête : scc.h

(Fourni dans le Kit de développement logiciel (SDK) d’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, [drive]\Program Files\VSIP 8.0\MSSCCI).

Voir aussi