SccGetCommandOptions-Funktion
Diese Funktion fordert den Benutzer zur Eingabe erweiterter Optionen für einen bestimmten Befehl auf.
Syntax
SCCRTN SccGetCommandOptions(
LPVOID pvContext,
HWND hWnd,
enum SCCCOMMAND iCommand,
LPCMDOPTS* ppvOptions
);
Parameter
pvContext
[in] Die Kontextstruktur des Quellcodeverwaltungs-Plug-Ins.
hWnd
[in] Ein Handle für das IDE-Fenster, das das Quellcodeverwaltungs-Plug-In als übergeordnetes Element für alle von ihr bereitgestellten Dialogfelder verwenden kann.
Icommand
[in] Der Befehl, für den erweiterte Optionen angefordert werden (siehe Befehlscode für mögliche Werte).
ppvOptions
[in] Die Optionsstruktur (kann auch sein NULL).
Rückgabewert
Die Plug-In-Implementierung dieser Funktion für die Quellcodeverwaltung wird voraussichtlich einen der folgenden Werte zurückgeben:
| Wert | Beschreibung |
|---|---|
| SCC_OK | Erfolg. |
| SCC_I_ADV_SUPPORT | Das Quellcodeverwaltungs-Plug-In unterstützt erweiterte Optionen für den Befehl. |
| SCC_I_OPERATIONCANCELED | Der Benutzer hat das Dialogfeld "Optionen" des Quellcodeverwaltungs-Plug-Ins abgebrochen. |
| SCC_E_OPTNOTSUPPORTED | Das Quellcodeverwaltungs-Plug-In unterstützt diesen Vorgang nicht. |
| SCC_E_ISCHECKEDOUT | Dieser Vorgang kann nicht für eine Datei ausgeführt werden, die zurzeit ausgecheckt ist. |
| SCC_E_ACCESSFAILURE | Es gab ein Problem beim Zugriff auf das Quellcodeverwaltungssystem, wahrscheinlich aufgrund von Netzwerk- oder Inhaltsproblemen. Es wird ein Wiederholungsversuche empfohlen. |
| SCC_E_NONSPECIFICERROR | Nicht spezifischer Fehler. |
Hinweise
Die IDE ruft diese Funktion zum ersten Mal auf ppvOptions=NULL , um festzustellen, ob das Quellcodeverwaltungs-Plug-In das Feature für erweiterte Optionen für den angegebenen Befehl unterstützt. Wenn das Plug-In das Feature für diesen Befehl unterstützt, ruft die IDE diese Funktion erneut auf, wenn der Benutzer erweiterte Optionen anfordert (in der Regel als Erweiterte Schaltfläche in einem Dialogfeld implementiert), und stellt einen Nicht-NULL-Zeiger für ppvOptions diesen Zeiger bereit NULL . Das Plug-In speichert alle erweiterten Optionen, die vom Benutzer in einer privaten Struktur angegeben werden, und gibt einen Zeiger auf diese Struktur zurück.ppvOptions Diese Struktur wird dann an alle anderen Quellcodeverwaltungs-Plug-In-API-Funktionen übergeben, die sie kennen müssen, einschließlich nachfolgenden Aufrufen der SccGetCommandOptions Funktion.
Ein Beispiel kann dazu beitragen, diese Situation zu klären.
Ein Benutzer wählt den Befehl "Abrufen " aus, und die IDE zeigt ein Dialogfeld "Abrufen " an. Die IDE ruft die SccGetCommandOptions Funktion auf iCommand und SCC_COMMAND_GET ppvOptions legt sie auf NULL. Dies wird vom Quellcodeverwaltungs-Plug-In als Frage interpretiert: "Haben Sie erweiterte Optionen für diesen Befehl?" Wenn das Plug-In zurückgibtSCC_I_ADV_SUPPORT, zeigt die IDE im Dialogfeld "Abrufen" eine Schaltfläche "Erweitert" an.
Wenn der Benutzer zum ersten Mal auf die Schaltfläche "Erweitert " klickt, ruft die IDE die SccGetCommandOptions Funktion erneut auf, diesmal mit einem Nicht-ElementNULL``ppvOptions , das auf einen NULL Zeiger zeigt. Das Plug-In zeigt ein eigenes Dialogfeld "Optionen abrufen" an, fordert den Benutzer zur Eingabe von Informationen auf, fügt diese Informationen in seine eigene Struktur ein und gibt einen Zeiger auf diese Struktur zurück.ppvOptions
Wenn der Benutzer erneut im selben Dialogfeld auf "Erweitert" klickt, ruft die IDE die SccGetCommandOptions Funktion erneut auf, ohne sich zu ändernppvOptions, sodass die Struktur wieder an das Plug-In übergeben wird. Auf diese Weise kann das Plug-In sein Dialogfeld auf die Werte neu initialisieren, die der Benutzer zuvor festgelegt hatte. Das Plug-In ändert die Struktur vor der Rückgabe.
Wenn der Benutzer im Dialogfeld "Abrufen" der IDE auf "OK" klickt, ruft die IDE SccGet auf, und übergibt die zurückgegebene ppvOptions Struktur, die die erweiterten Optionen enthält.
Hinweis
Der Befehl SCC_COMMAND_OPTIONS wird verwendet, wenn die IDE ein Dialogfeld "Optionen " anzeigt, in dem der Benutzer Einstellungen festlegen kann, die steuern, wie die Integration funktioniert. Wenn das Quellcodeverwaltungs-Plug-In ein eigenes Einstellungsdialogfeld bereitstellen möchte, kann es über eine Schaltfläche "Erweitert " im Dialogfeld "Einstellungen" der IDE angezeigt werden. Das Plug-In ist allein für das Abrufen und Speichern dieser Informationen verantwortlich; die IDE verwendet sie nicht oder ändert sie nicht.