Funzione SccGetCommandOptions
Questa funzione richiede all'utente le opzioni avanzate per un comando specificato.
SCCRTN SccGetCommandOptions(
LPVOID pvContext,
HWND hWnd,
enum SCCCOMMAND iCommand,
LPCMDOPTS* ppvOptions
);
Parametri
pvContext
[in] La struttura del contesto di plug-in controllo del codice sorgente.hWnd
[in] Un handle di finestra IDE che il plug-in controllo del codice sorgente possibile utilizzare come padre di tutte le finestre di dialogo che garantiscono.iCommand
[in] Le opzioni più avanzate di comando per il quale sono richieste ( Enumeratore codice comando per i valori possibili).ppvOptions
[in] La struttura di opzione (può essere NULL).
Valore restituito
L'implementazione di plug-in controllo del codice sorgente di questa funzione è previsto che restituisca uno dei seguenti valori:
Valore |
Descrizione |
|---|---|
SCC_OK |
Riuscita. |
SCC_I_ADV_SUPPORT |
Le opzioni avanzate di supportare di plug-in controllo del codice sorgente per il comando. |
SCC_I_OPERATIONCANCELED |
L'utente ha annullato la finestra di dialogo di opzioni di collegamento al controllo del codice sorgente. |
SCC_E_OPTNOTSUPPORTED |
Il plug-in controllo del codice sorgente non supporta questa operazione. |
SCC_E_ISCHECKEDOUT |
Non è possibile eseguire questa operazione in un file correntemente è verificato. |
SCC_E_ACCESSFAILURE |
Si è verificato un problema che accede al sistema di controllo del codice sorgente, probabilmente a causa di problemi di conflitto o della rete. Un tentativo è consigliato. |
SCC_E_NONSPECIFICERROR |
errore non specifico. |
Note
L'ide chiama per la prima volta che questa funzione con ppvOptions=NULL per determinare se il plug-in controllo del codice sorgente supporta la funzionalità avanzata di opzioni per il comando specificato. Se il plug-in supporta la funzionalità per il comando, l'ide chiamare nuovamente la funzione quando l'utente richiede affrontati le opzioni (generalmente implementate come pulsante di Avanzate in una finestra di dialogo) e in viene fornito un puntatore diverso da Null per ppvOptions che indica NULL un puntatore. Il plug-in archivia tutte le opzioni avanzate specificate dall'utente in una struttura privata e restituisce un puntatore alla struttura in ppvOptions. Questa struttura viene quindi passata a tutte le altre funzioni API di plug-in controllo del codice sorgente che devono sapere all'oggetto stesso, incluse le successive chiamate alla funzione di SccGetCommandOptions .
Un esempio può chiarire questa situazione.
Un utente sceglie il comando di ottenere e l'ide visualizza una finestra di dialogo di ottenere . L'ide chiama la funzione di SccGetCommandOptions con iCommand impostato su SCC_COMMAND_GET e ppvOptions impostato su NULL. Ciò viene interpretato dal plug-in controllo del codice sorgente come applicazione, “sono tutte le opzioni avanzate per questo comando?„ Se il plug-in restituisce SCC_I_ADV_SUPPORT, l'ide visualizza un pulsante di Avanzate nella finestra di dialogo di ottenere .
La prima volta che l'utente fa clic sul pulsante di Avanzate , l'ide chiamare nuovamente la funzione di SccGetCommandOptions , questa volta conNULLnonppvOptions che indica NULL un puntatore. Il plug-in consente di visualizzare la relativa finestra di dialogo di ottenere le opzioni , richiede informazioni all'utente, inserisce le informazioni nella propria struttura e restituisce un puntatore alla struttura in ppvOptions.
Se l'utente fa clic su Avanzate nella stessa finestra di dialogo, l'ide chiamare nuovamente la funzione di SccGetCommandOptions senza modificare ppvOptions, in modo che la struttura viene passata al plug-in. In questo modo il plug-in per reinitialize la finestra di dialogo per valori che l'utente precedentemente ha impostato. Il plug-in modifica la struttura sul posto prima di restituire.
Infine, quando l'utente fa clic su OK nella finestra di dialogo di ottenere IDE, l'ide chiama Funzione SccGet, passando la struttura restituita in ppvOptions contenente le opzioni avanzate.
Nota
Il comando SCC_COMMAND_OPTIONS viene utilizzato quando l'ide visualizza una finestra di dialogo di opzioni che consente alle preferenze utente che controllano quali l'integrazione funzioni.Se il plug-in controllo del codice sorgente desidera fornire la propria finestra di dialogo di preferenze, è possibile visualizzare da un pulsante di Avanzate nella finestra di dialogo delle preferenze dell'IDE.Il plug-in è unicamente responsabile di ottenere e di mantenere queste informazioni; l'ide non si utilizza o non lo modifica.