SccSetOption, fonction

Article
05/17/2015

Cette fonction définit les options qui contrôlent le comportement du plug-in contrôle de code source.

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

Paramètres

pvContext
[in] La structure du plug-in du contexte de contrôle de code source.
nOption
[in] l'option qui est définie.
dwVal
[in] Paramètres de l'option.

Valeur de retour

Il est recommandé que l'implémentation du plug-in du contrôle de code source de cette fonction retourne une des valeurs suivantes :

Valeur	Description
SCC_OK	L'option a été correctement définie.
SCC_I_SHARESUBPROJOK	Si nOption était SCC_OPT_SHARESUBPROJ retourné et le plug-in contrôle de code source permet à l'IDE pour définir le dossier de destination.
SCC_E_OPNOTSUPPORTED	L'option n'a pas été définie et ne doit pas être numérotés au moment.

Notes

L'IDE appelle cette fonction pour contrôler le comportement du plug-in contrôle de code source. Le premier paramètre, nOption, indique la valeur définie, tandis que le deuxième, dwVal, indique que faire avec cette valeur. Le plug-in stocke ces informations associées à pvContext, donc l'IDE doit appeler cette fonction après avoir appelé SccInitialize, fonction (mais pas nécessairement après chaque appel à SccOpenProject, fonction).

Résumé des options et de leurs valeurs :

nOption	dwValue	Description
SCC_OPT_EVENTQUEUE	SCC_OPT_EQ_DISABLE SCC_OPT_EQ_ENABLE	Activer/désactiver la mise en file d'attente d'arrière-plan d'événement.
SCC_OPT_USERDATA	Valeur arbitraire	Spécifie une valeur d'utilisateur à passer à la fonction de rappel d' OPTNAMECHANGEPFN .
SCC_OPT_HASCANCELMODE	SCC_OPT_HCM_NO SCC_OPT_HCM_YES	Indique si l'IDE prend en charge actuellement annuler une opération.
SCC_OPT_NAMECHANGEPFN	Pointeur vers une fonction de rappel d' OPTNAMECHANGEPFN	Définit un pointeur vers une fonction de rappel de changement de nom.
SCC_OPT_SCCCHECKOUTONLY	SCC_OPT_SCO_NO SCC_OPT_SCO_YES	Indique si l'IDE permet de vérifier en dehors de ses fichiers manuellement (via l'interface utilisateur du contrôle de code source) ou s'ils doivent être vérifiés uniquement via le plug-in contrôle de code source.
SCC_OPT_SHARESUBPROJ	N/A	Si le plug-in contrôle de code source permet à l'IDE pour spécifier le dossier du projet local, le plug-in retourne SCC_I_SHARESUBPROJOK.

SCC_OPT_EVENTQUEUE

Si nOption est SCC_OPT_EVENTQUEUE, l'IDE désactive (ou le réactive) le traitement en arrière-plan. Par exemple, lors d'une compilation, l'IDE peut demander au plug-in contrôle de code source pour arrêter le traitement de sur-inactif de tout type. Après la compilation, il réactive le traitement en arrière-plan pour conserver la file d'attente d'événements de la connexion jusqu'à présent. Correspondent à la valeur d' SCC_OPT_EVENTQUEUE d' nOption, les deux valeurs possibles pour dwVal, à savoir, SCC_OPT_EQ_ENABLE et SCC_OPT_EQ_DISABLE.

SCC_OPT_HASCANCELMODE

Si la valeur de nOption est SCC_OPT_HASCANCELMODE, l'IDE permet aux utilisateurs de longues opérations d'annulation. Le paramètre dwVal à SCC_OPT_HCM_NO (la valeur par défaut) indique que l'IDE n'a aucun mode d'annulation. Le plug-in contrôle de code source doit offrir son propre bouton Annuler s'il souhaite l'utilisateur peut annuler. SCC_OPT_HCM_YES indique que l'IDE offre la possibilité d'annuler une opération, le plug-in de SCC n'a pas besoin d'examiner leur bouton Annuler. Si l'IDE définit dwVal à SCC_OPT_HCM_YES, il est prêt pour répondre à SCC_MSG_STATUS et messages d' DOCANCEL envoyés à la fonction de rappel d' lpTextOutProc (consultez LPTEXTOUTPROC). Si l'IDE ne définit pas cette variable, le plug-in ne doit pas envoyer ces deux messages.

SCC_OPT_NAMECHANGEPFN

Si le nOption est défini à SCC_OPT_NAMECHANGEPFN, et le plug-in contrôle de code source et IDE le permettent, le plug-in peut réellement renommer ou déplacer un fichier pendant une opération de contrôle de code source. dwVal sera défini à un pointeur fonction de type OPTNAMECHANGEPFN. Pendant une opération de contrôle de code source, le plug-in peut appeler cette fonction, en passant trois paramètres. Ce sont l'ancien nom (avec le chemin qualifié complet) d'un fichier, le nouveau nom (avec le chemin qualifié complet) de ce fichier, et un pointeur vers les informations qui ont la pertinence avec l'IDE. L'IDE présente ce dernier pointeur en appelant SccSetOption avec nOption défini à SCC_OPT_USERDATA, avec dwVal pointant vers les données. La prise en charge de cette fonction est facultatif. Un VSSCI prise-que utilise cette capacité doivent initialiser les variables de données pointeur fonction et de l'utilisateur à NULL, et il ne doivent pas appeler une fonction de renommer à moins qu'elle ait été les données. Il doit également être préparé à gérer la valeur qu'il a été donné ou pour la modifier en réponse à un nouvel appel à SccSetOption. Cela ne se produit pas au milieu d'une opération de contrôle de code source, elle peut se produire entre les commandes.

SCC_OPT_SCCCHECKOUTONLY

Si le nOption est défini à SCC_OPT_SCCCHECKOUTONLY, l'IDE signale que les fichiers dans le projet ouvert ne doivent jamais être vérifiés manuellement via l'interface utilisateur du système de contrôle de code source. À la place, les fichiers doivent être vérifiés uniquement via le plug-in contrôle de code source sous le contrôle de l'IDE. Si dwValue est défini à SCC_OPT_SCO_NO, cela signifie que les fichiers doivent être traités normalement par le plug-in et peuvent être vérifiés par le biais de le contrôle de code source interface utilisateur. Si dwValue est défini à SCC_OPT_SCO_YES, seuls le plug-in est autorisé les fichiers, et l'interface utilisateur du système de contrôle de code source ne doit pas être appelé. C'est pour les situations où l'IDE peut avoir des « pseudo-fichiers » qui ont de sens dans le contrôle uniquement via l'IDE.

SCC_OPT_SHARESUBPROJ

SinOption est défini à SCC_OPT_SHARESUBPROJ, l'IDE teste si le plug-in contrôle de code source peut utiliser un dossier local spécifié en ajoutant des fichiers de contrôle de code source. La valeur du paramètre d' dwVal n'importe pas dans ce cas. Si le plug-in permet à l'IDE pour spécifier le dossier de destination locale où les fichiers sont ajoutés du contrôle de code source lorsque SccAddFromScc, fonction est appelé, le plug-in doit retourner SCC_I_SHARESUBPROJOK lorsque la fonction de SccSetOption est appelée. L'IDE utilise le paramètre d' lplpFileNames de la fonction d' SccAddFromScc pour passer dans le dossier de destination. Les utilisations de plug-in cette dossier de destination de placer les fichiers avez ajoutée du contrôle de code source. Si le plug-in ne retourne pas SCC_I_SHARESUBPROJOK lorsque l'option d' SCC_OPT_SHARESUBPROJ est définie, l'environnement IDE suppose que le plug-in peut ajouter uniquement des fichiers dans le dossier local actuel.