Fonction SccGetEventsSccGetEvents function

Cette fonction récupère un événement d’état en file d’attente.This function retrieves a queued status event.

SyntaxeSyntax

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

ParamètresParameters

pvContextpvContext
[in] La structure de contexte de plug-in de contrôle de source.[in] The source control plug-in context structure.

lpFileNamelpFileName
[in, out] Mémoire tampon où le plug-in de contrôle de code source place le nom de fichier renvoyé (_MAX_PATH caractères maximum).[in, out] Buffer where the source control plug-in puts the returned file name (up to _MAX_PATH characters).

lpStatuslpStatus
[in, out] Retourne le code d’état (consultez fichier de code d’état pour les valeurs possibles).[in, out] Returns status code (see File status code for possible values).

pnEventsRemainingpnEventsRemaining
[in, out] Retourne le nombre d’entrées restés dans la file d’attente après cet appel.[in, out] Returns number of entries left in the queue after this call. Si ce nombre est élevé, l’appelant peut décider d’appeler le SccQueryInfo pour obtenir toutes les informations à la fois.If this number is large, the caller may decide to call the SccQueryInfo to get all the information at once.

Valeur de retourReturn value

L’implémentation de plug-in de contrôle de source de cette fonction est censée retourner l’une des valeurs suivantes :The source control plug-in implementation of this function is expected to return one of the following values:

ValueValue DescriptionDescription
SCC_OKSCC_OK Obtenir les événements réussis.Get events succeeded.
SCC_E_OPNOTSUPPORTEDSCC_E_OPNOTSUPPORTED Cette fonction n’est pas pris en charge.This function is not supported.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR Erreur non spécifique.Nonspecific failure.

NotesRemarks

Cette fonction est appelée pendant le traitement inactif pour voir si des mises à jour d’état pour les fichiers sous contrôle de code source ont été.This function is called during idle processing to see if there have been any status updates for files under source control. Le plug-in de contrôle de code source gère l’état de tous les fichiers qu’il connaît, et chaque fois qu’une modification de l’état est indiqué par le plug-in, l’état et le fichier associé sont stockés dans une file d’attente.The source control plug-in maintains status of all the files it knows about, and whenever a change of status is noted by the plug-in, the status and the associated file are stored in a queue. Lorsque SccGetEvents est appelée, le haut l’élément de la file d’attente est récupéré et retourné.When SccGetEvents is called, the top element of the queue is retrieved and returned. Cette fonction est limitée pour retourner uniquement des informations mises en cache précédemment et doit avoir un temps de réponse très rapide (autrement dit, aucune lecture du disque ou demandant le système de contrôle de code source pour l’état) ; dans le cas contraire, les performances de l’IDE peuvent démarrer à se dégrader.This function is constrained to return only previously cached information and must have a very quick turnaround (that is, no reading of the disk or asking the source control system for status); otherwise the performance of the IDE may start to degrade.

S’il n’existe aucune mise à jour d’état au rapport, le plug-in de contrôle de code source stocke une chaîne vide dans la mémoire tampon vers laquelle pointée lpFileName.If there is no status update to report, the source control plug-in stores an empty string in the buffer pointed to by lpFileName. Sinon, le plug-in stocke le nom de chemin d’accès complet du fichier pour lequel les informations d’état a changé et retourne le code d’état approprié (l’une des valeurs détaillées dans fichier de code d’état).Otherwise, the plug-in stores the full path name of the file for which the status information has changed and returns the appropriate status code (one of the values detailed in File status code).

Voir aussiSee also

Fonctions d’API source contrôle plug-in Source control plug-in API functions
Code d’état de fichierFile status code