SccGetCommandOptions-Funktion
Diese Funktion fordert den Benutzer zur erweiterten Optionen für einen bestimmten Befehl auf.
SCCRTN SccGetCommandOptions(
LPVOID pvContext,
HWND hWnd,
enum SCCCOMMAND iCommand,
LPCMDOPTS* ppvOptions
);
Parameter
pvContext
[in] Die Quellcodeverwaltungs-Plug-In-Kontext Struktur.hWnd
[in] Ein Handle für das IDE-Fenster, das das Quellcodeverwaltungs-Plug-In als übergeordnetes Element für alle Dialogfelder verwenden kann, die er bereitstellt.iCommand
[in] Der Befehl für den erweiterten Optionen angefordert werden (siehe Befehlscode-Enumerator für mögliche Werte).ppvOptions
[in] Die Optionen unter Struktur (auch sein kann NULL).
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 |
Erfolgreich. |
SCC_I_ADV_SUPPORT |
Das Quellcodeverwaltungs-Plug-In unterstützt erweiterte Optionen für den Befehl. |
SCC_I_OPERATIONCANCELED |
Der Benutzer hat die der Quellcodeverwaltung Optionen Dialogfeld Steckverbindung ab. |
SCC_E_OPTNOTSUPPORTED |
Das Quellcodeverwaltungs-Plug-In diesen Vorgang nicht unterstützt. |
SCC_E_ISCHECKEDOUT |
Auf diesen Vorgang in einer Datei ausführen, die derzeit nicht ausgecheckt ist. |
SCC_E_ACCESSFAILURE |
Es bestand ein Problem, das das Quellcodeverwaltungssystem, wahrscheinlich aufgrund der Netzwerk- oder Konflikt bei der zugreift. Eine Wiederholung wird empfohlen. |
SCC_E_NONSPECIFICERROR |
Unspezifischer Fehler. |
Hinweise
Die IDE ruft diese Funktion zum ersten Mal mit ppvOptions= anNULL zu bestimmen, wenn das Quellcodeverwaltungs-Plug-In die Funktion der erweiterten Optionen für den angegebenen Befehl unterstützt. Wenn das Plug-In die Funktion für diesen Befehl unterstützt, wird die IDE diese Funktion wieder wenn die Benutzer erweiterten Optionen (üblicherweise als implementiert Erweitert Schaltfläche in einem Dialogfeld) und stellt ein Nicht-NULL-Zeiger für ppvOptions an, der einem NULL Zeiger verweist. Das Plug-In speichert alle erweiterten Optionen, die vom Benutzer in einer privaten Struktur angegeben wurden, und gibt einen Zeiger auf diese Struktur in ppvOptionszurück. Diese Struktur wird für alle anderen darin, die Quellcodeverwaltungs-Plug-In-API-Funktionen auskennen, einschließlich müssen nachfolgende Aufrufe an die SccGetCommandOptions-Funktion übergeben.
Ein Beispiel für diese Situation verhindert möglicherweise zu verdeutlichen.
Ein Benutzer wählt den Abrufen Befehl fehl, und die IDE Abrufen zeigt ein Dialogfeld an. Die IDE ruft die SccGetCommandOptions-Funktion mit iCommand an, die an SCC_COMMAND_GET und ppvOptions , das NULLfestgelegt ist. Dies wird durch das Quellcodeverwaltungs-Plug-In als die Frage „interpretiert, haben Sie alle erweiterten Optionen für diesen Befehl?“ Wenn das Plug-In SCC_I_ADV_SUPPORTzurückgibt, zeigt die IDE eine Erweitert Schaltfläche im Abrufen Dialogfeld an.
Beim ersten Erweitert der Benutzer auf die Schaltfläche klickt, ruft die IDE die SccGetCommandOptions-Funktion, dieses Mal mit Nicht-NULLppvOptions an, das einem NULL Zeiger verweist. Das Plug-In wird ein eigenes Optionen abrufen Dialogfeld fordert den Benutzer auf, führt Informationen zu dieser Informationen in seine eigene Struktur und gibt einen Zeiger auf diese Struktur in ppvOptionszurück.
Wenn der Benutzer auf Erweitert wieder in demselben Dialogfeld klickt, wird die IDE die SccGetCommandOptions-Funktion erneut aufrufen, ohne ppvOptionszu ändern, sodass die Struktur im Plug-In übergeben wird. Dadurch kann das Plug-In, um das Dialogfeld zu den Werten initialisieren, die der Benutzer zuvor festgelegt wurde. Das Plug-In wird die Struktur an der Stelle bevor sie beendet wird.
Wenn der Benutzer auf OK im Dialogfeld Abrufen klickt, ruft der IDE angezeigt SccGet-Funktionübergibt die IDE angezeigt, und die Struktur, die in ppvOptions zurückgegeben wurde, die die erweiterten Optionen enthält.
Hinweis
Der Befehl SCC_COMMAND_OPTIONS wird verwendet, wenn die IDE Optionen ein Dialogfeld angezeigt, das die festgelegten Einstellungen des Benutzers ermöglicht, die steuern, wie die Integration funktioniert.Wenn das Quellcodeverwaltungs-Plug-In ein eigenes Dialogfeld Einstellungen angeben möchte, kann er aus einer Erweitert Schaltfläche im Dialogfeld Einstellungen des IDE anzeigen.Das Plug-In ist für das Abrufen und das Beibehalten dieser Informationen allein verantwortlich. die IDE verwendet er nicht oder ändert sie.