SccBackgroundGet fonction)SccBackgroundGet function

11/04/2016
2 minutes de lecture

Cette fonction récupère, à partir du contrôle de code source, chacun des fichiers spécifiés sans intervention de l’utilisateur.This function retrieves from source control each of the specified files with no user interaction.

SyntaxeSyntax

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

ParamètresParameters

pContextpContext

dans Pointeur de contexte du plug-in de contrôle de code source.[in] The source control plug-in context pointer.

NfichiersnFiles

dans Nombre de fichiers spécifiés dans le lpFileNames tableau.[in] Number of files specified in the lpFileNames array.

lpFileNameslpFileNames

[in, out] Tableau de noms des fichiers à récupérer.[in, out] Array of names of files to be retrieved.

Notes

Les noms doivent être des noms de fichiers locaux complets.The names must be fully qualified local filenames.

dwFlagsdwFlags

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

dwBackgroundOperationIDdwBackgroundOperationID

dans Valeur unique associée à cette opération.[in] A unique value associated with this operation.

Valeur retournéeReturn value

L’implémentation du plug-in de contrôle de code source de cette fonction est supposé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:

ValeurValue	DescriptionDescription
SCC_OKSCC_OK	Opération exécutée avec succès.Operation completed successfully.
SCC_E_BACKGROUNDGETINPROGRESSSCC_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 le retourner uniquement s’il ne prend pas en charge les opérations batch simultanées).A background retrieval is already in progress (the source control plug-in should return this only if it does not support simultaneous batch operations).
SCC_I_OPERATIONCANCELEDSCC_I_OPERATIONCANCELED	L’opération a été annulée avant d’être terminée.Operation was canceled before being completed.

NotesRemarks

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.This function is always called on a thread different from the one that loaded the source control plug-in. Cette fonction ne doit pas être retournée tant qu’elle n’est pas terminée ; Toutefois, elle peut être appelée plusieurs fois avec plusieurs listes de fichiers, en même temps.This function is not expected to return until it is done; however, it can be called multiple times with multiple lists of files, all at the same time.

L’utilisation de l' dwFlags argument est identique à celle de SccGet.The use of the dwFlags argument is the same as the SccGet.