Partager via

SccGetEvents, fonction

  • Article

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

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

Paramètres

  • pvContext
    [in] La structure du plug-in du contexte de contrôle de code source.

  • lpFileName
    [in, out] Mémoire tampon dans laquelle le plug-in contrôle de code source place le nom de fichier retourné (jusqu'aux caractères de _MAX_PATH).

  • lpStatus
    [in, out] Code d'état de retour (consultez Énumérateur de code de statut de fichier pour les valeurs possibles).

  • pnEventsRemaining
    [in, out] Numéro de retour d'entrées laissées dans la file d'attente après cet appel. Si ce nombre est élevé, l'appelant peut décider d'appeler SccQueryInfo, fonction pour obtenir toutes les informations immédiatement.

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

Obtenir des é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 des temps d'inactivité pour voir si des mises à jour d'état pour les fichiers sous contrôle de code source. Le plug-in contrôle de code source maintient l'état de tous les fichiers qu'il connaît, et chaque fois qu'une modification d'état est notée par le plug-in, l'état et le fichier associé sont stockés dans une file d'attente. Lorsque SccGetEvents est appelé, le premier élément de la file d'attente est extrait et retournée. Cette fonction est limitée à retourner uniquement les informations précédemment mises en cache et doit avoir un retournement très rapide (autrement dit, aucune lecture du disque ou demander le système de contrôle de code source l'état) ; sinon les performances de l'IDE peut commencer à diminuer.

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

Voir aussi

Référence

Énumérateur de code de statut de fichier

Concepts

Fonctions API des plug-ins de contrôle de code source