Freigeben über

SccGetEvents-Funktion

  • Artikel

Diese Funktion ruft ein Statusereignis in der Warteschlange ab.

Syntax

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

Parameter

pvContext

[in] Die Kontextstruktur des Quellcodeverwaltungs-Plug-Ins.

lpFileName

[in, out] Puffer, in dem das Quellcodeverwaltungs-Plug-In den zurückgegebenen Dateinamen (bis zu _MAX_PATH Zeichen) einfügt.

lpStatus

[in, out] Gibt Statuscode zurück (siehe Dateistatuscode für mögliche Werte).

pnEventsRe Standard ing

[in, out] Gibt die Anzahl der Einträge zurück, die nach diesem Anruf in der Warteschlange verbleiben. Wenn diese Nummer groß ist, kann der Aufrufer entscheiden, die SccQueryInfo auf einmal aufzurufen, um alle Informationen auf einmal abzurufen.

Rückgabewert

Die Plug-In-Implementierung dieser Funktion für die Quellcodeverwaltung wird voraussichtlich einen der folgenden Werte zurückgeben:

Wert Beschreibung
SCC_OK Ereignisse wurden abgerufen.
SCC_E_OPNOTSUPPORTED Diese Funktion wird nicht unterstützt.
SCC_E_NONSPECIFICERROR Nicht spezifischer Fehler.

Hinweise

Diese Funktion wird während der Leerlaufverarbeitung aufgerufen, um festzustellen, ob Statusupdates für Dateien unter Quellcodeverwaltung vorhanden sind. Das Quellcodeverwaltungs-Plug-In Standard den Status aller dateien, über die es weiß, und wenn eine Änderung des Status durch das Plug-In angegeben wird, werden der Status und die zugeordnete Datei in einer Warteschlange gespeichert. Wenn SccGetEvents sie aufgerufen wird, wird das oberste Element der Warteschlange abgerufen und zurückgegeben. Diese Funktion ist darauf beschränkt, nur zuvor zwischengespeicherte Informationen zurückzugeben und eine sehr schnelle Bearbeitung zu haben (d. a. kein Lesen des Datenträgers oder die Aufforderung des Quellcodeverwaltungssystems zum Status); andernfalls kann die Leistung der IDE möglicherweise beeinträchtigt werden.

Wenn keine Statusaktualisierung zum Melden vorhanden ist, speichert das Quellcodeverwaltungs-Plug-In eine leere Zeichenfolge im Puffer, auf lpFileNamedie verwiesen wird. Andernfalls speichert das Plug-In den vollständigen Pfadnamen der Datei, für die sich die Statusinformationen geändert haben, und gibt den entsprechenden Statuscode zurück (einer der im Dateistatuscode aufgeführten Werte).

Siehe auch