POPLISTFUNC
Questo callback viene fornito a SccPopulateList dall'IDE e viene usato dal plug-in del controllo del codice sorgente per aggiornare un elenco di file o directory (fornito anche alla SccPopulateList funzione).
Quando un utente sceglie il comando Get nell'IDE, l'IDE visualizza una casella di riepilogo di tutti i file che l'utente può ottenere. Sfortunatamente, l'IDE non conosce l'elenco esatto di tutti i file che l'utente potrebbe ottenere; solo il plug-in ha questo elenco. Se altri utenti hanno aggiunto file al progetto di controllo del codice sorgente, questi file dovrebbero essere visualizzati nell'elenco, ma l'IDE non li conosce. L'IDE compila un elenco dei file che ritiene che l'utente possa ottenere. Prima di visualizzare questo elenco all'utente, chiama SccPopulateList , dando al plug-in del controllo del codice sorgente la possibilità di aggiungere ed eliminare file dall'elenco.
Firma
Il plug-in del controllo del codice sorgente modifica l'elenco chiamando una funzione implementata dall'IDE con il prototipo seguente:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Parametri
pvCallerData Il pvCallerData parametro passato dal chiamante (l'IDE) a SccPopulateList. Il plug-in del controllo del codice sorgente deve presupporre nulla sul contenuto di questo parametro.
fAddRemove Se TRUE, lpFileName è un file che deve essere aggiunto all'elenco di file. Se FALSE, lpFileName è un file che deve essere eliminato dall'elenco di file.
nStatus Status di lpFileName (combinazione dei SCC_STATUS bit; vedere Codice di stato del file per informazioni dettagliate).
lpFileName Percorso directory completo del nome file da aggiungere o eliminare dall'elenco.
Valore restituito
| Valore | Descrizione |
|---|---|
TRUE |
Il plug-in può continuare a chiamare questa funzione. |
FALSE |
Si è verificato un problema sul lato IDE ,ad esempio una situazione di memoria insufficiente. Il plug-in deve arrestare l'operazione. |
Osservazioni:
Per ogni file che il plug-in del controllo del codice sorgente vuole aggiungere o eliminare dall'elenco di file, chiama questa funzione, passando .lpFileName Il fAddRemove flag indica un nuovo file da aggiungere all'elenco o un file precedente da eliminare. Il nStatus parametro fornisce lo stato del file. Al termine dell'aggiunta e dell'eliminazione di file, il plug-in SCC viene restituito dalla chiamata SccPopulateList .
Nota
Il SCC_CAP_POPULATELIST bit di funzionalità è necessario per Visual Studio.