Funzione SccGetEvents
Questa funzione recupera un evento di stato in coda.
Sintassi
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parametri
pvContext
[in] Struttura del contesto del plug-in del controllo del codice sorgente.
lpFileName
[in, out] Buffer in cui il plug-in del controllo del codice sorgente inserisce il nome del file restituito (fino a _MAX_PATH caratteri).
lpStatus
[in, out] Restituisce il codice di stato (vedere Codice di stato del file per i valori possibili).
pnEventsRemaining
[in, out] Restituisce il numero di voci lasciate nella coda dopo questa chiamata. Se questo numero è elevato, il chiamante può decidere di chiamare SccQueryInfo per ottenere tutte le informazioni contemporaneamente.
Valore restituito
L'implementazione del plug-in del controllo del codice sorgente di questa funzione dovrebbe restituire uno dei valori seguenti:
| Valore | Descrizione |
|---|---|
| SCC_OK | Ottiene gli eventi riusciti. |
| SCC_E_OPNOTSUPPORTED | Questa funzione non è supportata. |
| SCC_E_NONSPECIFICERROR | Errore non specifico. |
Osservazioni:
Questa funzione viene chiamata durante l'elaborazione inattiva per verificare se sono stati apportati aggiornamenti dello stato per i file nel controllo del codice sorgente. Il plug-in del controllo del codice sorgente mantiene lo stato di tutti i file noti e ogni volta che viene indicato un cambiamento di stato dal plug-in, lo stato e il file associato vengono archiviati in una coda. Quando SccGetEvents viene chiamato, l'elemento superiore della coda viene recuperato e restituito. Questa funzione è vincolata a restituire solo informazioni memorizzate nella cache in precedenza e deve avere un turnaround molto rapido (ovvero, nessuna lettura del disco o la richiesta dello stato del sistema di controllo del codice sorgente); in caso contrario, le prestazioni dell'IDE potrebbero iniziare a peggiorare.
Se non è presente alcun aggiornamento dello stato per il report, il plug-in del controllo del codice sorgente archivia una stringa vuota nel buffer a lpFileNamecui punta . In caso contrario, il plug-in archivia il nome completo del percorso del file per cui le informazioni sullo stato sono state modificate e restituisce il codice di stato appropriato (uno dei valori descritti in Codice di stato del file).