POPLISTFUNC
Ce rappel est fourni à SccPopulateList, fonction par l'IDE et est utilisé par le plug-in contrôle de code source pour mettre à jour une liste des fichiers ou répertoires (également fourni à SccPopulateList la fonction).
Lorsqu'un utilisateur sélectionne la commande d' Obtenir dans l'IDE, l'IDE affiche une zone de liste de tous les fichiers que l'utilisateur peut obtenir. Malheureusement, l'IDE ne connaît la liste exacte de tous les fichiers que l'utilisateur peut obtenir ; seul le plug-in a cette liste. Si d'autres utilisateurs ont ajouté des fichiers au projet de contrôle de code source, ces fichiers doivent apparaître dans la liste, mais l'IDE ne sait pas eux. L'IDE génère une liste des fichiers qu'il pense que l'utilisateur peut obtenir. Avant qu'il affiche cette liste à l'utilisateur, il appelle SccPopulateList, fonction, donnant au plug-in contrôle de code source la possibilité d'ajouter et supprimer des fichiers de la liste.
Signature
Le plug-in contrôle de code source modifie la liste en appelant une fonction IDE-implémentée avec le prototype suivant :
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Paramètres
pvCallerData
le paramètre d' pvCallerData est passé par l'appelant (IDE) à SccPopulateList, fonction. Le plug-in contrôle de code source doit n'en supposant que rien sur le contenu de ce paramètre.fAddRemove
Si TRUE, lpFileName est un fichier qui doit être ajouté à la liste des fichiers. Si FALSE, lpFileName est un fichier qui doit être supprimé de la liste.nStatus
État d' lpFileName (combinaison de bits d' SCC_STATUS ; consultez Énumérateur de code de statut de fichier pour plus d'informations).lpFileName
Chemin d'accès complet du nom de fichier à ajouter ou à supprimer de la liste.
Valeur de retour
Valeur |
Description |
|---|---|
TRUE |
Le plug-in peut continuer à appeler cette fonction. |
FALSE |
Il y a eu un problème du côté de l'IDE (tel qu'une situation mémoire insuffisante). Le plug-in doit s'arrêter. |
Notes
Pour chaque fichier auquel le plug-in contrôle de code source souhaite ajouter ou supprimer de la liste des fichiers, il appelle cette fonction, en passant lpFileName. La balise d' fAddRemove indique un nouveau fichier à ajouter à la liste ou un ancien fichier de suppression. Le paramètre d' nStatus donne l'état du fichier. Lorsque le plug-in de SCC a terminé ajouter et supprimer des fichiers, il retourne de l'appel de SccPopulateList, fonction .
Notes
le bit de fonction d' SCC_CAP_POPULATELIST est requis pour Visual Studio.
Voir aussi
Référence
Énumérateur de code de statut de fichier