Funzione SccGetEvents
Questa funzione recupera un evento in coda di stato.
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parametri
pvContext
[in] La struttura del contesto di plug-in controllo del codice sorgente.lpFileName
[in, out] Buffer in cui il plug-in controllo del codice sorgente inserisce il nome file di output (fino ai caratteri di _MAX_PATH).lpStatus
[in, out] Codice di stato viene restituito ( Enumeratore del codice dello stato del file per i valori possibili).pnEventsRemaining
[in, out] Restituisce il numero di voci si lascia nella coda dopo la chiamata. Se questo numero è elevato, il chiamante può decidere di chiamare Funzione SccQueryInfo per ottenere tutte le informazioni immediatamente.
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 |
Ottenere gli eventi funzionanti. |
SCC_E_OPNOTSUPPORTED |
questa funzione non è supportata. |
SCC_E_NONSPECIFICERROR |
errore non specifico. |
Note
Questa funzione viene chiamata durante l'elaborazione inattiva per vedere se sono state gli aggiornamenti di stato per i file inclusi nel controllo del codice sorgente. Il plug-in controllo del codice sorgente mantiene lo stato di tutti i file di cui è a conoscenza e ogni volta che una modifica dello stato è indicata dal plug-in, lo stato e il file associato viene archiviato in una coda. Quando SccGetEvents viene chiamato, l'elemento superiore della coda viene recuperato e restituito. Questa funzione è vincolata per restituire solo le informazioni precedentemente memorizzato nella cache e deve disporre di un ritorno molto rapido ovvero non lettura del disco oppure chiedere il sistema di controllo del codice sorgente lo stato); altrimenti le prestazioni dell'IDE possono iniziare per impedire.
Se non c " è aggiornamento di stato da segnalare, il plug-in controllo del codice sorgente contiene una stringa vuota nel buffer puntato da lpFileName. In caso contrario, il plug-in archivia il nome di percorso completo del file per cui le informazioni sullo stato sono stati modificati e restituisce il codice di stato appropriato (uno dei valori riportati in Enumeratore del codice dello stato del file).
Vedere anche
Riferimenti
Enumeratore del codice dello stato del file