SccGetEvents-Funktion
Diese Funktion ruft ein in der Warteschlange stehenden Status Ereignis ab.
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parameter
pvContext
[in] Die Quellcodeverwaltungs-Plug-In-Kontext Struktur.lpFileName
[in, out] Puffer, in dem das Quellcodeverwaltungs-Plug-In die zurückgegebenen Dateinamen befinden (bis zu _MAX_PATH Zeichen).lpStatus
[in, out] Gibt Statuscode zurück (siehe Dateistatuscode-Enumerator für mögliche Werte).pnEventsRemaining
[in, out] Gibt die Anzahl von Einträgen zurück, die in der Warteschlange nach diesem Aufruf erfolgt sind. Wenn diese Zahl groß ist, kann der Aufrufer entscheidet sich, um SccQueryInfo-Funktion aufrufen, um alle Informationen sofort abrufen.
Rückgabewert
Die Quellcodeverwaltungs-Plug-In-Implementierung dieser Funktion wird erwartet, dass es sich um einen der folgenden Werte zurückgeben:
Wert |
Beschreibung |
|---|---|
SCC_OK |
Rufen Sie die erfolgreichen Ereignisse ab. |
SCC_E_OPNOTSUPPORTED |
Diese Funktion wird nicht unterstützt. |
SCC_E_NONSPECIFICERROR |
Unspezifischer Fehler. |
Hinweise
Diese Funktion wird während der Leerlaufverarbeitung aufgerufen, um zu prüfen, ob Statusaktualisierungen von Dateien unter Quellcodeverwaltung vorliegt. Das Quellcodeverwaltungs-Plug-In verfolgt den Status aller Dateien, die er etwa kennt und wenn eine Änderung des Status von das Plug-In erwähnt wird, den Status und die dazugehörige Dateien werden in einer Warteschlange gespeichert. Wenn SccGetEvents aufgerufen wird, ist das oberste Element der Warteschlange abgerufen und zurückgegeben. Diese Funktion ist eingeschränkt, dass nur zuvor zwischengespeicherte Informationen zurückzugeben und muss einen sehr schnellen Rücklauf (d. h. keine Lesevorgänge auf dem Datenträger bzw. das Quellcodeverwaltungssystem um den Status aufweisen;) angefordert Andernfalls wird möglicherweise die Leistung der IDE, um zu gefährden.
Wenn kein Status Anwendungsupdate vorliegt, zu melden, speichert das Quellcodeverwaltungs-Plug-In eine leere Zeichenfolge im Puffer, der durch lpFileNamedargestellt wird. Andernfalls enthält das Plug-In den vollständigen Pfadnamen der Datei, für die die Statusinformationen geändert wurden, und gibt die entsprechenden Statuscode zurück (einen der Werte einzeln in Dateistatuscode-Enumerator).