Funzione SccSetOption

Articolo
05/17/2015

Questa funzione imposta le opzioni che controllano il comportamento del plug-in controllo del codice sorgente.

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

Parametri

pvContext
[in] la struttura del contesto di plug-in controllo del codice sorgente.
nOption
[in] l'opzione che è stato impostato.
dwVal
[in] impostazioni per l'opzione.

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	L'opzione è stato correttamente impostata.
SCC_I_SHARESUBPROJOK	Se nOption è stato SCC_OPT_SHARESUBPROJ restituito e il plug-in controllo del codice sorgente consente che l'ide imposti la cartella di destinazione.
SCC_E_OPNOTSUPPORTED	L'opzione non è stata specificata e non deve essere basata su.

Note

L'ide chiama la funzione per controllare il comportamento del plug-in controllo del codice sorgente. Il primo parametro, nOption, indica il valore che viene fissando, mentre il secondo, dwVal, indica cosa fare con tale valore. Il plug-in di archiviare queste informazioni associate a pvContext, pertanto IDE necessario chiamare questa funzione dopo aver chiamato Funzione SccInitialize (ma non necessariamente dopo ogni chiamata a Funzione SccOpenProject).

Riepilogo delle opzioni e i relativi valori:

nOption	dwValue	Descrizione
SCC_OPT_EVENTQUEUE	SCC_OPT_EQ_DISABLE SCC_OPT_EQ_ENABLE	Attiva/disattiva l'accodamento in background di evento.
SCC_OPT_USERDATA	Valore arbitrario	Specifica un valore per l'utente per passare alla funzione di callback di OPTNAMECHANGEPFN .
SCC_OPT_HASCANCELMODE	SCC_OPT_HCM_NO SCC_OPT_HCM_YES	Indica se nell'IDE sono attualmente supportate annullare un'operazione.
SCC_OPT_NAMECHANGEPFN	Puntatore alla funzione di callback di OPTNAMECHANGEPFN	Imposta un puntatore a una funzione di callback di modifica del nome.
SCC_OPT_SCCCHECKOUTONLY	SCC_OPT_SCO_NO SCC_OPT_SCO_YES	Indica se l'ide consente di controllare i relativi file manualmente tramite l'interfaccia utente del controllo del codice sorgente) o se devono essere verificati solo con il plug-in controllo del codice sorgente.
SCC_OPT_SHARESUBPROJ	N/D	Se il plug-in controllo del codice sorgente consente all'IDE di specificare la cartella del progetto locale, il plug-in restituisce SCC_I_SHARESUBPROJOK.

SCC_OPT_EVENTQUEUE

Se nOption è SCC_OPT_EVENTQUEUE, l'ide sta disattivando o è riabilitando) l'elaborazione in background. Ad esempio, durante la compilazione, l'ide potrebbe indicare al plug-in controllo del codice sorgente per interrompere l'elaborazione sull'inattività di qualsiasi tipo. Dopo la compilazione, riabiliterebbe l'elaborazione in background per mantenere la coda eventi per il collegamento aggiornata. È corrispondente al valore di SCC_OPT_EVENTQUEUE di nOption, due valori possibili per dwVal, cioé, SCC_OPT_EQ_ENABLE e SCC_OPT_EQ_DISABLE.

SCC_OPT_HASCANCELMODE

Se il valore di nOption è SCC_OPT_HASCANCELMODE, l'ide consente di eseguire operazioni lunghe di annullamento. L'impostazione dwVal a SCC_OPT_HCM_NO (impostazione predefinita) indica che l'ide non è in grado di annullamento. Il plug-in controllo del codice sorgente necessario fornire il proprio pulsante Annulla se si desidera che l'utente possa da null. SCC_OPT_HCM_YES indica che l'ide consente di annullare un'operazione, pertanto il plug-in di SCC non deve visualizzare il relativo pulsante Annulla. Se l'ide imposta dwVal a SCC_OPT_HCM_YES, è in grado di rispondere a SCC_MSG_STATUS e messaggi di DOCANCEL inviati alla funzione di callback di lpTextOutProc (vedere LPTEXTOUTPROC). Se l'ide non imposta la variabile, il plug-in non deve inviare questi due messaggi.

SCC_OPT_NAMECHANGEPFN

Se il nOption è impostato su SCC_OPT_NAMECHANGEPFNe sia il plug-in controllo del codice sorgente che l'ide lo consentono, il plug-in consente di rinominare o spostare un file durante l'operazione di controllo del codice sorgente. dwVal viene impostato su un puntatore a funzione di tipo OPTNAMECHANGEPFN. Durante un'operazione di controllo del codice sorgente, il plug-in può chiamare questa funzione, passando in tre parametri. Si tratta del nome precedente con il percorso completo) di un file, il nuovo nome (con il percorso completo) del file e un puntatore a informazioni che ha attinenza all'IDE. L'ide introduce quest'ultimo puntatore chiamando SccSetOption con nOption impostato su SCC_OPT_USERDATA, con dwVal desiderata ai dati. Il supporto per questa funzione è facoltativo. Un VSSCI spina-che utilizza questa possibilità è necessario inizializzare le variabili di dati utente e dei puntatori a funzione di NULLe non devono chiamare una funzione di rinominare a meno che non sia stata quella specificata. Deve essere preparare utilizzare il valore che è stata specificata o modificarlo in risposta a una nuova chiamata a SccSetOption. Ciò non si verificherà al centro di un'operazione di comando del controllo del codice sorgente, ma può verificarsi tra i controlli.

SCC_OPT_SCCCHECKOUTONLY

Se il nOption è impostato su SCC_OPT_SCCCHECKOUTONLY, l'ide è indicato che i file nel progetto aperto non devono essere verificati mai manualmente tramite l'interfaccia utente del sistema di controllo del codice sorgente. Al contrario, i file devono essere verificati solo con il plug-in controllo del codice sorgente sotto il controllo dell'IDE. Se dwValue è impostato su SCC_OPT_SCO_NO, significa che i file devono essere trattati in genere dal plug-in e possono essere verificati con l'interfaccia utente del controllo del codice sorgente. Se dwValue è impostato su SCC_OPT_SCO_YES, quindi solo il plug-in è consentito per estrarre file e l'interfaccia utente del sistema di controllo del codice sorgente non deve essere richiamata. Ciò avviene per le situazioni in cui l'ide potrebbe essere “pseudo-file„ con significati estrarre solo con l'ide.

SCC_OPT_SHARESUBPROJ

SenOption è impostato su SCC_OPT_SHARESUBPROJ, l'ide sta testando se il plug-in controllo del codice sorgente possibile utilizzare una cartella locale specificata quando si aggiunge i file dal controllo del codice sorgente. Il valore del parametro di dwVal non è rilevante in questo caso. Se il plug-in consente all'IDE di specificare la cartella di destinazione locale in cui i file verranno aggiunti dal controllo del codice sorgente quando Funzione SccAddFromScc viene chiamato, il plug-in deve restituire SCC_I_SHARESUBPROJOK quando la funzione di SccSetOption è denominata. L'ide utilizza quindi il parametro di lplpFileNames della funzione di SccAddFromScc per passare la cartella di destinazione. Gli utilizzi del plug-in che la cartella di destinazione per inserire i file aggiunto dal controllo del codice sorgente. Se il plug-in non restituisce SCC_I_SHARESUBPROJOK quando l'opzione di SCC_OPT_SHARESUBPROJ è impostata, l'ide si presuppone che il plug-in possibile aggiungere solo file nella cartella locale corrente.