SccSetOption-Funktion

Artikel
08/03/2024

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

Syntax

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

Parameter

pvContext

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

nOption

[in] Die Option, die festgelegt wird.

dwVal

[in] Einstellungen für die Option.

Rückgabewert

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

Wert	Beschreibung
SCC_OK	Die Option wurde erfolgreich festgelegt.
SCC_I_SHARESUBPROJOK	Wird zurückgegeben, falls `nOption` vorhanden, `SCC_OPT_SHARESUBPROJ` und das Quellcodeverwaltungs-Plug-In ermöglicht der IDE das Festlegen des Zielordners.
SCC_E_OPNOTSUPPORTED	Die Option wurde nicht festgelegt und sollte nicht darauf vertrauen.

Hinweise

Die IDE ruft diese Funktion auf, um das Verhalten des Quellcodeverwaltungs-Plug-Ins zu steuern. Der erste Parameter , nOptiongibt den Wert an, der festgelegt wird, während der zweite, gibt an, dwValwas mit diesem Wert zu tun ist. Das Plug-In speichert diese Informationen, die einer pvContext``, IDE zugeordnet sind, damit die IDE diese Funktion aufrufen muss, nachdem die SccInitialize aufgerufen wurde (aber nicht unbedingt nach jedem Aufruf des SccOpenProject).

Zusammenfassung der Optionen und deren Werte:

`nOption`	`dwValue`	Beschreibung
`SCC_OPT_EVENTQUEUE`	`SCC_OPT_EQ_DISABLE` `SCC_OPT_EQ_ENABLE`	Aktiviert/deaktiviert die Warteschlange für Hintergrundereignisse.
`SCC_OPT_USERDATA`	Beliebiger Wert	Gibt einen Benutzerwert an, der an die OPTNAMECHANGEPFN-Rückruffunktion übergeben werden soll.
`SCC_OPT_HASCANCELMODE`	`SCC_OPT_HCM_NO` `SCC_OPT_HCM_YES`	Gibt an, ob die IDE derzeit das Abbrechen eines Vorgangs unterstützt.
`SCC_OPT_NAMECHANGEPFN`	Zeiger auf die RÜCKRUFFUNKTION OPTNAMECHANGEPFN	Legt einen Zeiger auf eine Rückruffunktion namensänderung fest.
`SCC_OPT_SCCCHECKOUTONLY`	`SCC_OPT_SCO_NO` `SCC_OPT_SCO_YES`	Gibt an, ob die IDE das Manuelle Auschecken der Dateien (über die Benutzeroberfläche der Quellcodeverwaltung) oder ob sie nur über das Quellcodeverwaltungs-Plug-In ausgecheckt werden müssen.
`SCC_OPT_SHARESUBPROJ`	N/V	Wenn das Quellcodeverwaltungs-Plug-In die IDE das Angeben des lokalen Projektordners zulässt, gibt das Plug-In zurück `SCC_I_SHARESUBPROJOK`.

SCC_OPT_EVENTQUEUE

Ist nOption dies SCC_OPT_EVENTQUEUEder Grund, wird die IDE die Hintergrundverarbeitung deaktivieren (oder erneut aktivieren). Beispielsweise kann die IDE während einer Kompilierung das Quellcodeverwaltungs-Plug-In anweisen, die Verarbeitung im Leerlauf jeglicher Art zu beenden. Nach der Kompilierung würde die Hintergrundverarbeitung erneut aktiviert, um die Ereigniswarteschlange des Plug-Ins auf dem neuesten Stand zu halten. Entsprechend 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 lautet nOption SCC_OPT_HASCANCELMODE, ermöglicht die IDE Benutzern das Abbrechen langer Vorgänge. Die Einstellung dwVal auf SCC_OPT_HCM_NO (Standardeinstellung) gibt an, dass die IDE keinen Abbruchmodus aufweist. Das Quellcodeverwaltungs-Plug-In muss eine eigene Schaltfläche "Abbrechen" anbieten, wenn der Benutzer in der Lage sein soll, den Vorgang abzubrechen. SCC_OPT_HCM_YES gibt an, dass die IDE die Möglichkeit zum Abbrechen eines Vorgangs bietet, sodass das SCC-Plug-In keine eigene Schaltfläche "Abbrechen" anzeigen muss. Wenn die IDE auf SCC_OPT_HCM_YES festgelegt dwVal ist, ist sie bereit, auf nachrichten zu reagieren SCC_MSG_STATUS und DOCANCEL an die lpTextOutProc Rückruffunktion gesendet zu werden (siehe LPTEXTOUTPROC). Wenn die IDE diese Variable nicht festgelegt hat, sollte das Plug-In diese beiden Nachrichten nicht senden.

SCC_OPT_NAMECHANGEPFN

Wenn nOption auf SCC_OPT_NAMECHANGEPFN", und sowohl das Quellcodeverwaltungs-Plug-In als auch die IDE zulassen, kann das Plug-In eine Datei während eines Quellcodeverwaltungsvorgangs tatsächlich umbenennen oder verschieben. Der dwVal Wert wird auf einen Funktionszeiger vom Typ OPTNAMECHANGEPFN festgelegt. Während eines Quellcodeverwaltungsvorgangs kann das Plug-In diese Funktion aufrufen, wobei drei Parameter übergeben werden. Dies sind der alte Name (mit vollqualifiziertem Pfad) einer Datei, der neue Name (mit vollqualifiziertem Pfad) dieser Datei und ein Zeiger auf Informationen, die für die IDE relevant sind. Die IDE sendet in diesem letzten Zeiger, indem SccSetOption mit nOption festgelegter Aufzählung SCC_OPT_USERDATAdwVal auf die Daten aufgerufen wird. Die Unterstützung für diese Funktion ist optional. Ein VSSCI-Plug-In, das diese Funktion verwendet, muss den Funktionszeiger und die Benutzerdatenvariablen NULLinitialisieren und darf keine Umbenennungsfunktion aufrufen, es sei denn, es wurde eine Funktion erteilt. Sie sollte auch darauf vorbereitet sein, den wert zu halten, den sie erhalten hat, oder sie als Reaktion auf einen neuen Aufruf SccSetOptionzu ändern. Dies geschieht nicht in der Mitte eines Quellcodeverwaltungsbefehlsvorgangs, aber es kann zwischen Befehlen geschehen.

SCC_OPT_SCCCHECKOUTONLY

Wenn nOption auf SCC_OPT_SCCCHECKOUTONLY"nOption" festgelegt ist, gibt die IDE an, dass die Dateien im aktuell geöffneten Projekt niemals manuell über die Benutzeroberfläche des Quellcodeverwaltungssystems ausgecheckt werden sollen. Stattdessen sollten die Dateien nur über das Quellcodeverwaltungs-Plug-In unter IDE-Steuerelement ausgecheckt werden. Wenn dwValue diese Einstellung festgelegt SCC_OPT_SCO_NOist, bedeutet dies, dass die Dateien normal vom Plug-In behandelt werden und über die Quellcodeverwaltungs-UI ausgecheckt werden können. Wenn dieser Wert auf SCC_OPT_SCO_YES dwValue festgelegt ist, darf nur das Plug-In Dateien auschecken, und die Benutzeroberfläche des Quellcodeverwaltungssystems sollte nicht aufgerufen werden. Dies gilt für Situationen, in denen die IDE möglicherweise "Pseudodateien" aufweist, die sinnvoll sind, nur über die IDE auszuchecken.

SCC_OPT_SHARESUBPROJ

Wenn nOption diese Einstellung SCC_OPT_SHARESUBPROJfestgelegt ist, testet die IDE, ob das Quellcodeverwaltungs-Plug-In beim Hinzufügen von Dateien aus der Quellcodeverwaltung einen angegebenen lokalen Ordner verwenden kann. Der Wert des dwVal Parameters spielt in diesem Fall keine Rolle. Wenn das Plug-In es der IDE ermöglicht, den lokalen Zielordner anzugeben, in dem die Dateien aus der Quellcodeverwaltung hinzugefügt werden, wenn SccAddFromScc aufgerufen wird, muss das Plug-In zurückgegeben SCC_I_SHARESUBPROJOK werden, wenn die SccSetOption Funktion aufgerufen wird. Die IDE verwendet dann den lplpFileNames Parameter der SccAddFromScc Funktion, um den Zielordner zu übergeben. Das Plug-In verwendet diesen Zielordner, um die aus der Quellcodeverwaltung hinzugefügten Dateien zu platzieren. Wenn das Plug-In beim Festlegen der SCC_OPT_SHARESUBPROJ Option nicht zurückgegeben SCC_I_SHARESUBPROJOK wird, geht die IDE davon aus, dass das Plug-In Dateien nur im aktuellen lokalen Ordner hinzufügen kann.

Freigeben über