SccPopulateList (fonction)SccPopulateList Function

Cette fonction met à jour une liste de fichiers pour une commande de contrôle source particulière et fournit l’état du contrôle source sur tous les fichiers donnés.This function updates a list of files for a particular source control command and supplies source control status on all given files.

SyntaxeSyntax

SCCRTN SccPopulateList (  
   LPVOID          pvContext,  
   enum SCCCOMMAND nCommand,  
   LONG            nFiles,  
   LPCSTR*         lpFileNames,  
   POPLISTFUNC     pfnPopulate,  
   LPVOID          pvCallerData,  
   LPLONG          lpStatus,  
   LONG            fOptions  
);  

ParamètresParameters

pvContextpvContext
[in] La structure de contexte plug-in de contrôle de code source.[in] The source control plug-in context structure.

%n%ncommandenCommand
[in] La commande de contrôle de code source qui est appliquée à tous les fichiers dans le lpFileNames tableau (consultez le Code de commande pour obtenir la liste des commandes possible).[in] The source control command that will be applied to all files in the lpFileNames array (see Command Code for a list of possible commands).

nFilesnFiles
[in] Nombre de fichiers dans le lpFileNames tableau.[in] Number of files in the lpFileNames array.

lpFileNameslpFileNames
[in] Tableau des noms de fichiers connu à l’IDE.[in] An array of file names known to the IDE.

pfnPopulatepfnPopulate
[in] La fonction de rappel à appeler pour ajouter et supprimer des fichiers IDE (consultez POPLISTFUNC pour plus d’informations).[in] The IDE callback function to call to add and remove files (see POPLISTFUNC for details).

pvCallerDatapvCallerData
[in] Valeur qui doit être transmis sans modification à la fonction de rappel.[in] Value that is to be passed unchanged to the callback function.

lpStatuslpStatus
[dans, out] Tableau pour le plug-in pour retourner les indicateurs d’état pour chaque fichier de contrôle de code source.[in, out] An array for the source control plug-in to return the status flags for each file.

fOptionsfOptions
[in] Indicateurs de commandes (consultez la section « Indicateur PopulateList » de indicateurs de bits utilisés par des commandes spécifiques pour plus d’informations).[in] Command flags (see the "PopulateList flag" section of Bitflags Used by Specific Commands for details).

Valeur de retourReturn Value

L’implémentation de plug-in de contrôle de source de cette fonction est censée retourner l’une des valeurs suivantes :The source control plug-in implementation of this function is expected to return one of the following values:

ValueValue DescriptionDescription
SCC_OKSCC_OK Opération réussie.Success.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR Erreur non spécifique.Nonspecific failure.

NotesRemarks

Cette fonction examine la liste des fichiers pour son état actuel.This function examines the list of files for its current status. Elle utilise le pfnPopulate fonction de rappel pour notifier l’appelant quand un fichier ne correspond pas aux critères pour le nCommand.It uses the pfnPopulate callback function to notify the caller when a file does not match the criteria for the nCommand. Par exemple, si la commande est SCC_COMMAND_CHECKIN un fichier dans la liste n’est pas extrait, puis le rappel est utilisé pour informer l’appelant.For example, if the command is SCC_COMMAND_CHECKIN and a file in the list is not checked out, then the callback is used to inform the caller. Parfois, le plug-in de contrôle de code source peut trouver des autres fichiers qui peuvent faire partie de la commande et les ajouter.Occasionally, the source control plug-in may find other files that could be part of the command and add them. Cela permet, par exemple, un utilisateur de Visual Basic extraire un fichier .bmp qui est utilisé par son projet mais n’apparaît pas dans le fichier de projet Visual Basic.This allows, for example, a Visual Basic user to check out a .bmp file that is used by his or her project but does not appear in the Visual Basic project file. Un utilisateur choisit le obtenir dans l’IDE.A user chooses the Get command in the IDE. L’IDE affiche une liste de tous les fichiers qu’il pense que l’utilisateur peut obtenir, mais avant que la liste s’affiche, le SccPopulateList est appelée pour vous assurer que la liste à afficher est à jour.The IDE will display a list of all files that it thinks the user can get, but before the list is shown, the SccPopulateList function is called to make sure the list to be displayed is up to date.

ExempleExample

L’IDE génère une liste de fichiers il pense que l’utilisateur peut obtenir.The IDE builds a list of files that it thinks the user can get. Avant d’afficher cette liste, il appelle le SccPopulateList de fonction, en donnant le plug-in de contrôle de source de la possibilité d’ajouter et de supprimer des fichiers à partir de la liste.Before it displays this list, it calls the SccPopulateList function, giving the source control plug-in the opportunity to add and delete files from the list. Le plug-in modifie la liste en appelant la fonction de rappel donnée (consultez POPLISTFUNC pour plus d’informations).The plug-in modifies the list by calling the given callback function (see POPLISTFUNC for more details).

Continue le plug-in appeler le pfnPopulate (fonction), qui ajoute et supprime les fichiers, jusqu'à ce qu’il est terminé et le renvoie à partir de la SccPopulateList (fonction).The plug-in continues to call the pfnPopulate function, which adds and deletes files, until it is finished and then returns from the SccPopulateList function. L’IDE peut ensuite afficher sa liste.The IDE can then display its list. Le lpStatus tableau représente tous les fichiers dans la liste d’origine passé par l’IDE.The lpStatus array represents all files in the original list passed in by the IDE. Le plug-in renseigne l’état de tous les fichiers de plus à faire l’utilisation de la fonction de rappel.The plug-in fills in the status of all these files in addition to making use of the callback function.

Note

Un plug-in de contrôle de code source a toujours la possibilité pour simplement retourner immédiatement à partir de cette fonction, en laissant la liste car il s’agit.A source control plug-in always has the option to simply return immediately from this function, leaving the list as it is. Si un plug-in implémente cette fonction, il peut indiquer cela en définissant le SCC_CAP_POPULATELIST capacité des indicateurs de bits dans le premier appel à la SccInitialize.If a plug-in implements this function, it can indicate this by setting the SCC_CAP_POPULATELIST capability bitflag in the first call to the SccInitialize. Par défaut, le plug-in doit toujours supposer que tous les éléments passés sont des fichiers.By default, the plug-in should always assume that all items being passed in are files. Toutefois, si l’IDE définit le SCC_PL_DIR indicateur dans le fOptions tous les éléments en cours de passage de paramètre, sont à prendre en compte les répertoires.However, if the IDE sets the SCC_PL_DIR flag in the fOptions parameter, all the items being passed in are to be considered directories. Le plug-in doit ajouter tous les fichiers qui appartiennent dans les répertoires.The plug-in should add all the files that belong in the directories. L’IDE ne passe jamais dans un mélange de fichiers et répertoires.The IDE will never pass in a mixture of files and directories.

Voir aussiSee Also

Fonctions d’API de plug-in de contrôle de source Source Control Plug-in API Functions
SccInitialize SccInitialize
POPLISTFUNC POPLISTFUNC
Indicateurs de bits utilisés par des commandes spécifiques Bitflags Used by Specific Commands
Code de commandeCommand Code