SccProperties (fonction)SccProperties Function

Cette fonction affiche les propriétés de contrôle de source d’un fichier ou un projet.This function displays source control properties for a file or project.

SyntaxeSyntax

SCCRTN SccProperties (  
   LPVOID pvContext,  
   HWND   hWnd,  
   LPCSTR lpFileName  
);  

ParamètresParameters

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

hWndhWnd
[in] Handle vers la fenêtre de l’IDE que le plug-in de contrôle de code source peut utiliser en tant que parent pour toutes les boîtes de dialogue qu’il fournit.[in] A handle to the IDE window that the source control plug-in can use as a parent for any dialog boxes that it provides.

lpFileNamelpFileName
[in] Le nom de chemin d’accès complet du fichier ou du projet.[in] The fully qualified path name of the file or project.

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 Les propriétés ont été correctement affichées.Properties were successfully displayed.
SCC_I_RELOADFILESCC_I_RELOADFILE Le système de contrôle de version a modifié les propriétés du fichier, afin de l’IDE doit recharger ce fichier.The version control system has modified the file properties, so the IDE should reload this file.
SCC_E_PROJNOTOPENSCC_E_PROJNOTOPEN Le projet spécifié n’a pas été ouvert dans le contrôle de code source.The specified project has not been opened in source control.
SCC_E_NOTAUTHORIZEDSCC_E_NOTAUTHORIZED L’utilisateur n’est pas autorisé à afficher les propriétés de ce fichier ou le projet.The user is not authorized to view properties of this file or project.
SCC_E_FILENOTCONTROLLEDSCC_E_FILENOTCONTROLLED Le fichier spécifié ou le projet n’est pas sous contrôle de code source.The specified file or project is not under source control.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR

SCC_E_UNKNOWNERRORSCC_E_UNKNOWNERROR
Une erreur inconnue ou générale s’est produite.An unknown or general error occurred.

NotesRemarks

Le plug-in de contrôle de code source affiche les propriétés dans sa propre boîte de dialogue.The source control plug-in displays the properties in its own dialog box.

Les propriétés sont définies par le plug-in de contrôle de code source et peuvent différer de plug-in pour le plug-in.The properties are defined by the source control plug-in and may differ from plug-in to plug-in. Si le plug-in lui permet de modifier les propriétés du contrôle de code source d’un fichier, elle doit retourner SCC_I_RELOAD pour signaler l’IDE ce fichier ou le projet doit être rechargé.If the plug-in allows the user to change the source control properties of a file, it should return SCC_I_RELOAD to signal the IDE that this file or project needs to be reloaded.

Voir aussiSee Also

Fonctions d’API du plug-in de contrôle de code sourceSource Control Plug-in API Functions