SccQueryInfo (fonction)SccQueryInfo Function

Cette fonction obtient les informations d’état pour un ensemble de fichiers sélectionnés sous contrôle de code source.This function obtains status information for a set of selected files under source control.

SyntaxeSyntax

SCCRTN SccQueryInfo(  
   LPVOID  pvContext,  
   LONG    nFiles,  
   LPCSTR* lpFileNames,  
   LPLONG  lpStatus  
);  

ParamètresParameters

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

nFilesnFiles
[in] Nombre de fichiers spécifiés dans le lpFileNames tableau et la longueur de la lpStatus tableau.[in] Number of files specified in the lpFileNames array and the length of the lpStatus array.

lpFileNameslpFileNames
[in] Un tableau de noms de fichiers à interroger.[in] An array of names of files to be queried.

lpStatuslpStatus
[dans, out] Tableau dans lequel le plug-in de contrôle de code source retourne les indicateurs d’état pour chaque fichier.[in, out] An array in which the source control plug-in returns the status flags for each file. Pour plus d’informations, consultez Code d’état de fichier.For more information, see File Status Code.

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 Requête a réussi.Query was successful.
SCC_E_ACCESSFAILURESCC_E_ACCESSFAILURE Un problème avec l’accès au système de contrôle source, probablement dû à des problèmes de réseau ou de conflit est survenu.There was a problem with accessing the source control system, probably caused by network or contention issues. Une nouvelle tentative est recommandée.A retry is recommended.
SCC_E_PROJNOTOPENSCC_E_PROJNOTOPEN Le projet n’est pas ouvert sous contrôle de code source.The project is not open under source control.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR Erreur non spécifique.Nonspecific failure.

NotesRemarks

Si lpFileName est une chaîne vide, il n’existe actuellement aucune information d’état pour mettre à jour.If lpFileName is an empty string, there is currently no status information to update. Dans le cas contraire, il est le nom de chemin d’accès complet du fichier pour lequel les informations d’état peuvent ont été modifiés.Otherwise, it is the full path name of the file for which the status information may have changed.

Le tableau de retour peut être un masque de bits de SCC_STATUS_xxxx bits.The return array can be a bitmask of SCC_STATUS_xxxx bits. Pour plus d’informations, consultez Code d’état de fichier.For more information, see File Status Code. Un système de contrôle de code source ne peut pas en charge tous les types de bit.A source control system may not support all bit types. Par exemple, si SCC_STATUS_OUTOFDATE n’est pas disponible, le bit n’est pas défini.For example, if SCC_STATUS_OUTOFDATE is not offered, the bit is just not set.

Lorsque vous utilisez cette fonction pour extraire des fichiers, notez les points suivants MSSCCI exigences de l’état :When using this function to check out files, note the following MSSCCI status requirements:

  • SCC_STATUS_OUTBYUSER est définie lorsque l’utilisateur actuel a extrait le fichier.SCC_STATUS_OUTBYUSER is set when the current user has checked out the file.

  • SCC_STATUS_CHECKEDOUT Impossible de définir SCC_STATUS_OUTBYUSER est définie.SCC_STATUS_CHECKEDOUT cannot be set unless SCC_STATUS_OUTBYUSER is set.

  • SCC_STATUS_CHECKEDOUT est définie uniquement lorsque le fichier est extrait dans le répertoire de travail désigné.SCC_STATUS_CHECKEDOUT is only set when the file is checked-out into the designated working directory.

  • Si le fichier est extrait par l’utilisateur actuel dans un répertoire autre que le répertoire de travail SCC_STATUS_OUTBYUSER est définie mais SCC_STATUS_CHECKEDOUT n’est pas.If the file is checked-out by the current user into a directory other than the working directory, SCC_STATUS_OUTBYUSER is set but SCC_STATUS_CHECKEDOUT is not.

Voir aussiSee Also

Fonctions d’API de plug-in de contrôle de source Source Control Plug-in API Functions
Code d’état de fichierFile Status Code