Fonction SccBackgroundGet

  • Article

Cette fonction récupère à partir du contrôle de code source chacun des fichiers spécifiés sans interaction utilisateur.

Syntaxe

SCCRTN SccBackgroundGet(
   LPVOID  pContext,
   LONG    nFiles,
   LPCSTR* lpFileNames,
   LONG    dwFlags,
   LONG    dwBackgroundOperationID
);

Paramètres

pContext

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

nFiles

[in] Nombre de fichiers spécifiés dans le lpFileNames tableau.

lpFileNames

[in, out] Tableau de noms de fichiers à récupérer.

Remarque

Les noms doivent être des noms locaux complets.

dwFlags

[in] Indicateurs de commande (SCC_GET_ALL, SCC_GET_RECURSIVE).

dwBackgroundOperationID

[in] Valeur unique associée à cette opération.

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 Opération exécutée avec succès.
SCC_E_BACKGROUNDGETINPROGRESS Une récupération en arrière-plan est déjà en cours (le plug-in de contrôle de code source doit retourner cela uniquement s’il ne prend pas en charge les opérations de traitement par lots simultanées).
SCC_I_OPERATIONCANCELED L’opération a été annulée avant d’être terminée.

Notes

Cette fonction est toujours appelée sur un thread différent de celui qui a chargé le plug-in de contrôle de code source. Cette fonction n’est pas censée retourner tant qu’elle n’est pas terminée ; Toutefois, il peut être appelé plusieurs fois avec plusieurs listes de fichiers, tout en même temps.

L’utilisation de l’argument dwFlags est identique à sccGet.

Voir aussi