POPLISTFUNC
Ce rappel est fourni à SccPopulateList par l’IDE et est utilisé par le plug-in de contrôle de code source pour mettre à jour une liste de fichiers ou de répertoires (également fournis à la SccPopulateList fonction).
Lorsqu’un utilisateur choisit la commande Get 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 pas la liste exacte de tous les fichiers que l’utilisateur peut obtenir ; seul le plug-in contient 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 les connaît pas. L’IDE génère une liste des fichiers qu’il pense que l’utilisateur peut obtenir. Avant d’afficher cette liste à l’utilisateur, elle appelle SccPopulateList, pour permettre au plug-in de contrôle de code source d’ajouter et de supprimer des fichiers de la liste.
Signature
Le plug-in de contrôle de code source modifie la liste en appelant une fonction implémentée par l’IDE avec le prototype suivant :
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Paramètres
pvCallerData Le pvCallerData paramètre transmis par l’appelant (l’IDE) à SccPopulateList. Le plug-in de contrôle de code source ne doit supposer rien sur le contenu de ce paramètre.
fAddRemove If TRUE, lpFileName est un fichier qui doit être ajouté à la liste de fichiers. Si FALSE, lpFileName est un fichier qui doit être supprimé de la liste de fichiers.
nStatus Status of lpFileName (combinaison des bits ; consultez Le code d’état du SCC_STATUS fichier pour plus d’informations).
lpFileName Full directory path of the file name to add or delete from the list.
Valeur retournée
| Valeur | Description |
|---|---|
TRUE |
Le plug-in peut continuer à appeler cette fonction. |
FALSE |
Il y a eu un problème côté IDE (par exemple, une situation de mémoire insuffisante). Le plug-in doit arrêter l’opération. |
Notes
Pour chaque fichier que le plug-in de contrôle de code source souhaite ajouter ou supprimer dans la liste de fichiers, il appelle cette fonction, en passant le lpFileName. L’indicateur fAddRemove indique un nouveau fichier à ajouter à la liste ou à un ancien fichier à supprimer. Le nStatus paramètre donne l’état du fichier. Lorsque le plug-in SCC a terminé d’ajouter et de supprimer des fichiers, il retourne à partir de l’appel SccPopulateList .
Remarque
Le SCC_CAP_POPULATELIST bit de fonctionnalité est requis pour Visual Studio.