Funzione SccInitialize
Questa funzione consente di inizializzare il plug-in controllo del codice sorgente e fornisce le funzionalità e i limiti all'ambiente di sviluppo integrato (IDE) (IDE).
SCCRTN SccInitialize (
LPVOID* ppvContext,
HWND hWnd,
LPCSTR lpCallerName,
LPSTR lpSccName,
LPLONG lpSccCaps,
LPSTR lpAuxPathLabel,
LPLONG pnCheckoutCommentLen,
LPLONG pnCommentLen
);
Parametri
ppvContext
[in] Il plug-in controllo del codice sorgente possibile inserire un puntatore alla relativa struttura di contesto di seguito.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.lpCallerName
[in] Il nome del programma chiami il plug-in controllo del codice sorgente.lpSccName
[in, out] Il buffer in cui il plug-in controllo del codice sorgente inserisce il proprio nome (non superare SCC_NAME_LEN).lpSccCaps
[out] Restituisce i flag della funzionalità di collegamento al controllo del codice sorgente.lpAuxPathLabel
[in, out] Il buffer in cui il plug-in controllo del codice sorgente inserisce una stringa che descrive il parametro di lpAuxProjPath restituito da Funzione SccOpenProject e Funzione SccGetProjPath (non superare SCC_AUXLABEL_LEN).pnCheckoutCommentLen
[out] Restituisce la lunghezza massima consentita per un commento al completamento della transazione.pnCommentLen
[out] Restituisce la lunghezza massima consentita per altri commenti.
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 |
Inizializzazione del controllo del codice sorgente è riuscita. |
SCC_E_INITIALIZEFAILED |
Il sistema potrebbe non essere inizializzato. |
SCC_E_NOTAUTHORIZED |
L'utente non è autorizzato a eseguire l'operazione specificata. |
SCC_E_NONSPECFICERROR |
errore non specifico; il sistema di controllo del codice sorgente non è stato inizializzato. |
Note
L'ide questa funzione viene chiamata quando innanzitutto carica il plug-in controllo del codice sorgente. Consente all'IDE per comunicare determinate informazioni, ad esempio il nome del chiamante, al plug-in. L'ide ottengono anche a determinate informazioni quali la lunghezza massima consentita per i commenti e le funzionalità del collegamento.
I punti di ppvContext a un puntatore di NULL . Il plug-in controllo del codice sorgente possibile allocare una struttura per il proprio utilizzo e archiviare un puntatore alla struttura in ppvContext. L'ide passa il puntatore su ogni altra funzione API di VSSCI, in modo che il plug-in disponga di informazioni sul contesto disponibili senza riordinare i all'archivio globale e le istanze supportano più del plug-in. Questa struttura deve essere rilasciata quando Funzione SccUninitialize viene chiamato.
I parametri di lpSccName e di lpCallerName consentono all'IDE e del plug-in controllo del codice sorgente per lo scambio dei nomi. Tali nomi possono essere utilizzati semplicemente per distinguere tra più istanze, o è effettivamente visualizzati nei menu o finestre di dialogo.
Il parametro di lpAuxPathLabel è una stringa utilizzata come commento per identificare il percorso del progetto ausiliario archiviato nel file di soluzione e viene passato al plug-in controllo del codice sorgente in una chiamata a Funzione SccOpenProject. Visual SourceSafe utilizza progetto SourceSafe la stringa “: „; altri plug-in del controllo del codice sorgente devono evitare da da utilizzando questa particolare stringa.
Il parametro di lpSccCaps fornisce il plug-in controllo del codice sorgente un percorso per archiviare i bitflags che indicano le funzionalità del collegamento. (Per un elenco completo dei bitflags di funzionalità, vedere Flag di funzionalità). Ad esempio, se i piani del plug-in scrivere i risultati in chiamante-fornissero la funzione di callback, il plug-in imposterebbe il bit di capacità SCC_CAP_TEXTOUT. Ciò segnalerebbe l'ide per creare una finestra per i risultati del controllo della versione.