Fonction SccDirQueryInfoSccDirQueryInfo function

Cette fonction examine une liste de répertoires complets pour leur état actuel.This function examines a list of fully qualified directories for their current status.

SyntaxeSyntax

SCCRTN SccDirQueryInfo(  
LPVOID  pContext,  
LONG    nDirs,  
LPCSTR* lpDirNames,  
LPLONG  lpStatus  
);  

ParamètresParameters

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

nDirsnDirs
[in] Le nombre de répertoires sélectionnés à interroger.[in] The number of directories selected to be queried.

lpDirNameslpDirNames
[in] Un tableau des chemins qualifiés complets des répertoires à interroger.[in] An array of fully qualified paths of the directories to be queried.

lpStatuslpStatus
[in, out] Une structure de tableau pour le plug-in pour retourner les indicateurs d’état de contrôle de code source (consultez code d’état Directory pour plus d’informations).[in, out] An array structure for the source control plug-in to return the status flags (see Directory status code for details).

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 La requête a réussi.The query was successful.
SCC_E_OPNOTSUPPORTEDSCC_E_OPNOTSUPPORTED Le système de contrôle de code source ne prend pas en charge cette opération.The source code control system does not support this operation.
SCC_E_ACCESSFAILURESCC_E_ACCESSFAILURE Impossible d’accéder au système de contrôle source, probablement en raison de problèmes réseau ou de contention.There was a problem accessing the source control system, probably due to network or contention issues. Une nouvelle tentative est recommandée.A retry is recommended.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR

SCC_E_UNKNOWNERRORSCC_E_UNKNOWNERROR
Erreur non spécifique.Nonspecific failure.

NotesRemarks

La fonction remplit le tableau de résultats avec un masque de bits de bits à partir de la SCC_DIRSTATUS famille (consultez code d’état Directory), une entrée pour chaque répertoire donné.The function fills the return array with a bitmask of bits from the SCC_DIRSTATUS family (see Directory status code), one entry for each directory given. Le tableau de statut est alloué par l’appelant.The status array is allocated by the caller.

L’IDE utilise cette fonction avant qu’un répertoire est renommé pour vérifier si le répertoire est sous contrôle de code source en interrogeant si elle possède un projet correspondant.The IDE uses this function before a directory is renamed to check whether the directory is under source control by querying whether it has a corresponding project. Si le répertoire n’est pas sous contrôle de code source, l’IDE peut fournir l’avertissement approprié à l’utilisateur.If the directory is not under source control, the IDE can provide the proper warning to the user.

Note

Si un plug-in de contrôle de code source choisit de n'implémenter pas une ou plusieurs valeurs d’état, non implémentées bits doivent être définis sur zéro.If a source control plug-in chooses to not implement one or more of the status values, unimplemented bits should be set to zero.

Voir aussiSee also

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