Partager via


SccProperties, fonction

Cette fonction affiche les propriétés de contrôle de code source pour un fichier ou un projet.

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

Paramètres

  • pvContext
    [in] La structure du plug-in du contexte de contrôle de code source.

  • hWnd
    [in] Un handle de la fenêtre IDE que le plug-in contrôle de code source peut utiliser en tant que parent pour toutes les boîtes de dialogue qu'elle fournit.

  • lpFileName
    [in] Le nom de chemin d'accès complet du fichier ou du projet.

Valeur de retour

Il est recommandé que l'implémentation du plug-in du contrôle de code source de cette fonction retourne une des valeurs suivantes :

Valeur

Description

SCC_OK

Les propriétés ont été correctement affichées.

SCC_I_RELOADFILE

Le système de contrôle de version a modifié les propriétés de fichier, donc l'IDE doit recharger ce fichier.

SCC_E_PROJNOTOPEN

le projet spécifié n'a pas été ouvert dans le contrôle de code source.

SCC_E_NOTAUTHORIZED

L'utilisateur n'est pas autorisé à afficher les propriétés de ce fichier ou projet.

SCC_E_FILENOTCONTROLLED

Le fichier spécifié ou le projet n'est pas sous contrôle de code source.

SCC_E_NONSPECIFICERROR

SCC_E_UNKNOWNERROR

une erreur inconnue ou générale produite.

Notes

Le plug-in contrôle de code source affiche les propriétés dans sa propre boîte de dialogue.

Les propriétés sont définies par le plug-in contrôle de code source et peuvent différer du plug-in au plug-in. Si le plug-in permet à l'utilisateur de modifier les propriétés de contrôle de code source d'un fichier, elle doit retourner SCC_I_RELOAD pour signaler l'IDE que ce fichier ou projet doit être rechargé.

Voir aussi

Concepts

Fonctions API des plug-ins de contrôle de code source