POPLISTFUNCPOPLISTFUNC

Ce rappel est fourni à la SccPopulateList par l’IDE et est utilisé par le plug-in de contrôle de code source pour mettre à jour une liste des fichiers ou répertoires (également fourni à la SccPopulateList fonction).This callback is supplied to the SccPopulateList by the IDE and is used by the source control plug-in to update a list of files or directories (also supplied to the SccPopulateList function).

Quand un utilisateur choisit le obtenir commande dans l’IDE, l’IDE affiche une zone de liste de tous les fichiers que l’utilisateur peut obtenir.When a user chooses the Get command in the IDE, the IDE displays a list box of all files that the user can get. Malheureusement, l’IDE ne connaît pas la liste exacte de tous les fichiers que l’utilisateur peut obtenir ; uniquement le plug-in a cette liste.Unfortunately, the IDE does not know the exact list of all the files that the user might get; only the plug-in has this list. 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 à leur sujet.If other users have added files to the source code control project, these files should appear in the list, but the IDE does not know about them. L’IDE génère une liste des fichiers il pense que l’utilisateur peut obtenir.The IDE builds a list of the files that it thinks the user can get. Avant d’afficher cette liste à l’utilisateur, il appelle la SccPopulateList , en donnant le plug-in de contrôle de code source Obtient une occasion d’ajouter et supprimer des fichiers à partir de la liste.Before it displays this list to the user, it calls the SccPopulateList, giving the source control plug-in a chance to add and delete files from the list.

SignatureSignature

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 :The source control plug-in modifies the list by calling an IDE-implemented function with the following prototype:

typedef BOOL (*POPLISTFUNC) (  
   LPVOID pvCallerData,  
   BOOL fAddRemove,  
   LONG nStatus,  
   LPSTR lpFileName  
);  

ParamètresParameters

pvCallerDatapvCallerData
Le pvCallerData paramètre passé par l’appelant (l’IDE) pour le SccPopulateList.The pvCallerData parameter passed by the caller (the IDE) to the SccPopulateList. Le plug-in de contrôle de code source doit supposer rien sur le contenu de ce paramètre.The source control plug-in should assume nothing about the contents of this parameter.

fAddRemovefAddRemove
Si TRUE, lpFileName est un fichier qui doit être ajouté à la liste des fichiers.If TRUE, lpFileName is a file that should be added to the file list. Si FALSE, lpFileName est un fichier qui doit être supprimé à partir de la liste des fichiers.If FALSE, lpFileName is a file that should be deleted from the file list.

ÉtatnStatus
État de lpFileName (une combinaison de la SCC_STATUS bits ; consultez Code d’état de fichier pour plus d’informations).Status of lpFileName (a combination of the SCC_STATUS bits; see File Status Code for details).

lpFileNamelpFileName
Chemin complet du répertoire du nom de fichier pour ajouter ou supprimer de la liste.Full directory path of the file name to add or delete from the list.

Valeur de retourReturn Value

ValueValue DescriptionDescription
TRUE Le plug-in peut continuer d’appeler cette fonction.The plug-in can continue calling this function.
FALSE Un problème a été sur le côté de l’IDE (par exemple, une sortie de la mémoire).There has been a problem on the IDE side (such as an out of memory situation). Le plug-in doit arrêter une opération.The plug-in should stop operation.

NotesRemarks

Pour chaque fichier du plug-in de contrôle de code source souhaite ajouter ou supprimer de la liste des fichiers, il appelle cette fonction, en passant le lpFileName.For each file that the source control plug-in wants to add to or delete from the file list, it calls this function, passing in the lpFileName. Le fAddRemove indicateur signale un nouveau fichier à ajouter à la liste ou un ancien fichier à supprimer.The fAddRemove flag indicates a new file to add to the list or an old file to delete. Le nStatus paramètre indique l’état du fichier.The nStatus parameter gives the status of the file. Une fois l’analyse de plug-in a ajout et suppression de fichiers, il quitte la SccPopulateList appeler.When the SCC plug-in has finished adding and deleting files, it returns from the SccPopulateList call.

Note

Le SCC_CAP_POPULATELIST bit de fonctionnalité est requise pour Visual Studio.The SCC_CAP_POPULATELIST capability bit is required for Visual Studio.

Voir aussiSee Also

Fonctions de rappel implémentées par l’IDE Callback Functions Implemented by the IDE
Plug-ins de contrôle de code source Source Control Plug-ins
SccPopulateList SccPopulateList
Code d’état de fichierFile Status Code