Funzione SccPopulateList
Questa funzione aggiorna un elenco di file per un comando di controllo del codice sorgente specifico e verificare lo stato del controllo del codice sorgente nei file specificati.
SCCRTN SccPopulateList (
LPVOID pvContext,
enum SCCCOMMAND nCommand,
LONG nFiles,
LPCSTR* lpFileNames,
POPLISTFUNC pfnPopulate,
LPVOID pvCallerData,
LPLONG lpStatus,
LONG fOptions
);
Parametri
pvContext
[in] La struttura del contesto di plug-in controllo del codice sorgente.Si noti che il Controllo dell'account utente influisce anche sulla distribuzione.
[in] Il comando di controllo del codice sorgente che verrà applicato a tutti i file nella matrice di lpFileNames (vedere Enumeratore codice comando per un elenco di comandi possibili).nFiles
[in] Numero di file nella matrice di lpFileNames .lpFileNames
[in] Una matrice dei nomi file definiti all'IDE.pfnPopulate
[in] La funzione di callback dell'IDE da chiamare per aggiungere e rimuovere file (vedere POPLISTFUNC per informazioni dettagliate).pvCallerData
[in] Prevedere che deve essere passato invariato alla funzione di callback.lpStatus
[in, out] Una matrice per il plug-in controllo del codice sorgente restituiscano i contrassegni di stato per ogni file.fOptions
[in] Flag di comando (vedere la sezione “flag di PopulateList„ Flag di bit utilizzati da comandi specifici per dettagli).
Valore restituito
L'implementazione di plug-in controllo del codice sorgente di questa funzione è previsto che restituisca uno dei seguenti valori:
Valore |
Descrizione |
|---|---|
SCC_OK |
Riuscita. |
SCC_E_NONSPECIFICERROR |
errore non specifico. |
Note
Questa funzione esamina l'elenco dei file per il relativo stato corrente. Utilizza la funzione di callback di pfnPopulate per notificare al chiamante quando un file non soddisfa i criteri per nCommand. Ad esempio, se il comando è SCC_COMMAND_CHECKIN e un file nell'elenco non è stato estratto, il callback viene utilizzato per notificare al chiamante. Talvolta, il plug-in controllo del codice sorgente possibile trovare altri file che possono fare parte di comando e aggiungerli. Ciò consente, ad esempio, un utente di Visual Basic estrarre un file jpg utilizzato dal progetto ma non viene visualizzato nel file di progetto di Visual Basic. Un utente sceglie il comando di ottenere nell'IDE. L'ide visualizza un elenco di tutti i file che prevede che l'utente possa ottenere, ma prima che l'elenco venga indicato, la funzione di SccPopulateList viene chiamata per verificare che l'elenco venga visualizzato sia aggiornato.
Esempio
L'ide compila un elenco dei file che prevede che l'utente possa ottenere. Prima di visualizzare questo elenco, chiama la funzione di SccPopulateList , consentendo al plug-in controllo del codice sorgente la possibilità di aggiungere ed eliminare i file dall'elenco. Il plug-in modifica l'elenco chiamando la funzione di callback specificato (vedere POPLISTFUNC per informazioni dettagliate).
Il plug-in continua alla funzione di pfnPopulate , aggiungendo ed eliminazione file, fino a unico e ritornare dalla funzione di SccPopulateList . L'ide quindi possibile visualizzare il relativo elenco. La matrice di lpStatus rappresenta tutti i file nell'elenco originale passato dall'IDE. Il plug-in riempie lo stato di tutti questi file oltre a utilizzare la funzione di callback.
Nota
Un plug-in controllo del codice sorgente è sempre possibile restituire semplicemente immediatamente da questa funzione, lasciando l'elenco mentre è.Se un plug-in implementa questa funzione, può indicare tale scopo il bitflag di funzionalità di SCC_CAP_POPULATELIST nella prima chiamata a Funzione SccInitialize.Per impostazione predefinita, il plug-in deve sempre presupporre che tutti gli elementi a cui vengono passati sono file.Tuttavia, se l'ide imposta il flag di SCC_PL_DIR nel parametro di fOptions , tutti gli elementi a cui vengono passati devono essere considerati directory.Il plug-in deve aggiungere tutti i file a cui appartengono le directory.L'ide non supererà mai in una combinazione di file e directory.