Partager via

Fonction SccGetEvents

  • Article

Cette fonction récupère un événement d’état mis en file d’attente.

Syntaxe

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

Paramètres

pvContext

[in] Structure de contexte du plug-in de contrôle de code source.

lpFileName

[in, out] Mémoire tampon où le plug-in de contrôle de code source place le nom de fichier retourné (jusqu’à _MAX_PATH caractères).

lpStatus

[in, out] Retourne le code d’état (consultez le code d’état du fichier pour connaître les valeurs possibles).

pnEventsRemaining

[in, out] Retourne le nombre d’entrées laissées dans la file d’attente après cet appel. Si ce nombre est volumineux, l’appelant peut décider d’appeler sccQueryInfo pour obtenir toutes les informations à la fois.

Valeur retournée

L’implémentation du plug-in de contrôle de code source de cette fonction est censée retourner l’une des valeurs suivantes :

Valeur Description
SCC_OK Obtenir les événements réussis.
SCC_E_OPNOTSUPPORTED Cette fonction n'est pas prise en charge.
SCC_E_NONSPECIFICERROR Échec non spécifique.

Notes

Cette fonction est appelée pendant le traitement inactif pour voir s’il y a eu des mises à jour d’état pour les fichiers sous contrôle de code source. Le plug-in de contrôle de code source conserve l’état de tous les fichiers qu’il connaît et chaque fois qu’un changement d’état est noté par le plug-in, l’état et le fichier associé sont stockés dans une file d’attente. Quand SccGetEvents elle est appelée, l’élément supérieur de la file d’attente est récupéré et retourné. Cette fonction est contrainte de retourner uniquement les informations précédemment mises en cache et doit avoir un délai très rapide (autrement dit, aucune lecture du disque ou demande au système de contrôle de code source d’état) ; sinon, les performances de l’IDE peuvent commencer à se dégrader.

S’il n’existe aucune mise à jour d’état pour signaler, le plug-in de contrôle de code source stocke une chaîne vide dans la mémoire tampon pointée par lpFileName. Sinon, le plug-in stocke le nom complet du chemin d’accès du fichier pour lequel les informations d’état ont changé et retourne le code d’état approprié (une des valeurs détaillées dans le code d’état du fichier).

Voir aussi