SccSetOption-Funktion

Artikel
05/16/2015

Diese Funktion legt Optionen fest, die das Verhalten des Quellcodeverwaltungs-Plug-In steuern.

SCCRTN SccSetOption(
   LPVOID pvContext,
   LONG   nOption,
   LONG   dwVal
);

Parameter

pvContext
[in] Die Quellcodeverwaltungs-Plug-In-Kontext Struktur.
nOption
[in] Die Option, die festgelegt wird.
dwVal
[in] Die Einstellungen für die Option.

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	Die Option wurde erfolgreich festgelegt.
SCC_I_SHARESUBPROJOK	Ein zurückgegebenes, wenn nOption war, SCC_OPT_SHARESUBPROJ und das Quellcodeverwaltungs-Plug-In kann der IDE, um den Zielordner festzulegen.
SCC_E_OPNOTSUPPORTED	Die Option wurde nicht festgelegt und darf nicht gebaut werden.

Hinweise

Die IDE ruft diese Funktion auf, um das Verhalten des Quellcodeverwaltungs-Plug-In zu steuern. Der erste Parameter, nOption, gibt den Wert an, der festgelegt wird, während der zweite dwVal, was angibt, mit diesem Wert zu erreichen. Das Plug-In speichert diese Informationen, die pvContext, zugeordnet sind. Daher muss die IDE diese Funktion aufrufen, nachdem es SccInitialize-Funktion aufgerufen hat (aber nicht notwendigerweise nach jedem Aufruf von SccOpenProject-Funktion).

Zusammenfassung der Optionen und ihre Werte:

nOption	dwValue	Beschreibung
SCC_OPT_EVENTQUEUE	SCC_OPT_EQ_DISABLE SCC_OPT_EQ_ENABLE	Aktiviert Hintergrund wird queuing.
SCC_OPT_USERDATA	Beliebiger Wert	Gibt einen OPTNAMECHANGEPFN an die Rückruffunktion übergeben werden soll, Nutzwert.
SCC_OPT_HASCANCELMODE	SCC_OPT_HCM_NO SCC_OPT_HCM_YES	Gibt an, ob die IDE derzeit den Abbruch eines Vorgangs unterstützt.
SCC_OPT_NAMECHANGEPFN	Zeiger auf die Rückruffunktion OPTNAMECHANGEPFN	Legt einen Zeiger auf eine Rückruffunktion Änderung NAME fest.
SCC_OPT_SCCCHECKOUTONLY	SCC_OPT_SCO_NO SCC_OPT_SCO_YES	Gibt an, ob die IDE die Überprüfung aus den Dateien manuell über die Benutzeroberfläche der Quellcodeverwaltung zulässig () oder ob sie nur durch das Quellcodeverwaltungs-Plug-In ausgecheckt werden müssen.
SCC_OPT_SHARESUBPROJ	Nicht zutreffend	Wenn das Quellcodeverwaltungs-Plug-In der IDE ermöglicht, dass lokale Projektordner anzugeben, gibt das Plug-In SCC_I_SHARESUBPROJOK zurück.

SCC_OPT_EVENTQUEUE

Wenn nOptionSCC_OPT_EVENTQUEUE der IDE deaktiviert ist (oder erneut aktiviert), die Hintergrundverarbeitung. Zum Beispiel kann während eines kompilierten, wiese die IDE das Quellcodeverwaltungs-Plug-In auf, um die Art der Verarbeitung auf leerlauf zu beenden. Nachdem das kompilierte, die Hintergrundverarbeitung erneut aktivieren, um die Ereigniswarteschlange der Steckverbindung auf dem neuesten Stand zu halten. Gemäß dem SCC_OPT_EVENTQUEUE-Wert von nOption gibt es zwei mögliche Werte für dwVal, nämlich, SCC_OPT_EQ_ENABLE und SCC_OPT_EQ_DISABLE.

SCC_OPT_HASCANCELMODE

Wenn der Wert für nOptionSCC_OPT_HASCANCELMODE ist, ermöglicht die IDE Benutzer Operationen lange deaktiviert. Einstellung dwVal zu SCC_OPT_HCM_NO (Standard) gibt an, dass der Modus der IDE keinen Löschen. Das Quellcodeverwaltungs-Plug-In muss seine eigene Schaltfläche Abbrechen, wenn sie den Benutzer in der Lage sein sollen abzubrechen. SCC_OPT_HCM_YES gibt an, dass die IDE die Möglichkeit bietet, eine Operation abzubrechen. Daher muss das SCC-Plug-In keine eigene Schaltfläche Abbrechen anzuzeigen. Wenn die IDE auf dwValSCC_OPT_HCM_YES festlegt, ist es DOCANCEL vorbereitet, auf SCC_MSG_STATUS und Meldungen zu reagieren, die zur lpTextOutProc Rückruffunktion gesendet werden (siehe LPTEXTOUTPROC). Wenn die IDE nicht über diese Variable festgelegt wird, sollte das Plug-In diese beiden Meldungen nicht senden.

SCC_OPT_NAMECHANGEPFN

Wenn nOption zu SCC_OPT_NAMECHANGEPFN festgelegt ist und das Quellcodeverwaltungs-Plug-In und die IDE es zulässt, kann das Plug-In eine Datei während eines Quellcodeverwaltungsvorgangs tatsächlich umbenennen oder verschieben. dwVal wird auf einen Funktionszeiger des Typs OPTNAMECHANGEPFN festgelegt. Während eines Quellcodeverwaltungsvorgangs kann das Plug-In diese Funktion aufrufen und drei Parameter übergeben. Diese werden der alte Name (mit vollqualifiziertem Pfad) einer Datei, der neue Name (mit vollqualifiziertem Pfad) dieser Datei und ein Zeiger zu Themen, in denen Bedeutung in der IDE hat. Die IDE sendet den letzten in diesen Zeiger, indem SccSetOption mit nOption aufruft, das SCC_OPT_USERDATA festgelegt ist, mit dwVal zeigenden an Daten. Unterstützung für diese Funktion ist optional. Ein VSSCI, Stecker-dass diese Fähigkeit verwendet wird, muss seine Funktionszeiger- und Benutzerdaten variablen zu NULL initialisieren und es darf keine Funktion zum Umbenennen einer aufrufen, es sei denn, es wurde ein. Sie sollte außerdem darauf vorbereitet sein, den Wert aufzunehmen, den es oder ihn als Reaktion auf einen neuen Aufruf angegeben wurde SccSetOption zu ändern. Dies geschieht nicht mitten in einer Quellcodeverwaltung Arbeitsweise der Befehle. Es geschieht möglicherweise von Befehlen.

SCC_OPT_SCCCHECKOUTONLY

Wenn nOption zu SCC_OPT_SCCCHECKOUTONLY festgelegt ist, wird die IDE an, dass die derzeit geöffneten Dateien im Projekt über die Benutzeroberfläche des Quellcodeverwaltungssystems manuell ausgecheckt überprüft werden sollen. Stattdessen sollten die Dateien nur über das Quellcodeverwaltungs-Plug-In unter IDE-Steuerelement ausgecheckt werden. Wenn dwValue zu SCC_OPT_SCO_NO festgelegt ist, bedeutet dies, dass die Dateien mit dem Plug-In normalerweise behandelt werden sollen, und über die Benutzeroberfläche der Quellcodeverwaltung ausgecheckt werden können. Wenn dwValue zu SCC_OPT_SCO_YES festgelegt ist, wird nur das Plug-In wird ermöglicht, dass Dateien auszuchecken und die Benutzeroberfläche des Quellcodeverwaltungssystems sollte nicht aufgerufen werden. Dies ist für Situationen, in denen die IDE "simulierten Dateien" sind sinnvoll, die nur von der IDE auszuchecken.

SCC_OPT_SHARESUBPROJ

Wenn nOption zu SCC_OPT_SHARESUBPROJ festgelegt ist, prüft die IDE, ob das Quellcodeverwaltungs-Plug-In einen angegebenen lokalen Ordner verwenden kann, wenn sich Dateien aus der Quellcodeverwaltung hinzugefügt wird. Der Wert des dwVal-Parameters ist in diesem Fall nicht von Bedeutung. Wenn das Plug-In der IDE können, um den lokalen Zielordner anzugeben, in dem sich die Dateien aus der Quellcodeverwaltung hinzugefügt werden, wenn SccAddFromScc-Funktion aufgerufen wird, muss das Plug-In SCC_I_SHARESUBPROJOK zurückgeben, wenn die SccSetOption-Funktion aufgerufen wird. Die IDE verwendet dann den lplpFileNames-Parameter der SccAddFromScc-Funktion, die in den Zielordner zu übergeben. Das Plug-In wird die Zielordner, um die Dateien zu platzieren, die von der Quellcodeverwaltung hinzugefügt werden. Wenn das Plug-In nicht SCC_I_SHARESUBPROJOK zurückgibt, wenn die SCC_OPT_SHARESUBPROJ Option festgelegt wird, hat die IDE an, dass das Plug-In in der Lage ist, nur Dateien im aktuellen lokalen Ordner hinzufügen.