Déboguer des extensions pour les outils SharePoint dans Visual StudioDebug extensions for the SharePoint tools in Visual Studio

Vous pouvez déboguer des extensions d’outils SharePoint dans l’instance expérimentale ou l’instance normale de Visual Studio.You can debug SharePoint tools extensions in the experimental instance or the regular instance of Visual Studio. Si vous avez besoin dépanner le comportement d’une extension, vous pouvez également modifier les valeurs de Registre pour afficher les informations d’erreur supplémentaires et de configurer la façon dont Visual Studio exécute les commandes SharePoint.If you need to troubleshoot the behavior of an extension, you can also modify registry values to display additional error information and to configure how Visual Studio executes SharePoint commands.

Déboguer des extensions dans l’instance expérimentale de Visual StudioDebug extensions in the experimental instance of Visual Studio

Pour protéger votre environnement de développement Visual Studio à partir de la corruption accidentelle par des extensions non testées, le Kit de développement logiciel Visual Studio fournit une autre instance de Visual Studio, appelée le instance expérimentale, que vous pouvez utiliser Pour installer et tester des extensions.To safeguard your Visual Studio development environment from accidental corruption by untested extensions, the Visual Studio SDK provides an alternative Visual Studio instance, called the experimental instance, that you can use to install and test extensions. Vous développez de nouvelles extensions à l’aide de l’instance normale de Visual Studio, mais que vous déboguez et que vous les exécutez dans l’instance expérimentale.You develop new extensions by using the regular instance of Visual Studio, but you debug and run them in the experimental instance. Pour plus d’informations, consultez l’Instance expérimentale.For more information, see The Experimental Instance.

Si vous utilisez un projet VSIX pour déployer votre extension, et le projet VSIX est le projet de démarrage dans votre solution, Visual Studio installe automatiquement et s’exécute l’extension dans l’instance expérimentale lorsque vous déboguez votre solution.If you use a VSIX project to deploy your extension, and the VSIX project is the startup project in your solution, Visual Studio automatically installs and runs the extension in the experimental instance when you debug your solution. Le projet de démarrage est le projet qui démarre lorsque vous déboguez une solution qui contient plusieurs projets.The startup project is the project that starts when you debug a solution that contains multiple projects. Pour plus d’informations sur l’utilisation d’un projet VSIX pour déployer votre extension, consultez déployer des extensions pour les outils SharePoint dans Visual Studio.For more information about using a VSIX project to deploy your extension, see Deploy extensions for the SharePoint tools in Visual Studio.

Pour obtenir des exemples qui montrent comment déboguer différents types d’extensions dans l’instance expérimentale de Visual Studio, consultez les procédures suivantes :For examples that demonstrate how to debug various types of extensions in the experimental instance of Visual Studio, see the following walkthroughs:

Déboguer des extensions dans l’instance normale de Visual StudioDebug extensions in the regular instance of Visual Studio

Si vous souhaitez déboguer votre projet d’extension dans l’instance normale de Visual Studio, vous devez tout d’abord installer l’extension dans l’instance normale.If you want to debug your extension project in the regular instance of Visual Studio, first install the extension in the regular instance. Ensuite, attacher le débogueur à un deuxième processus Visual Studio.Then, attach the debugger to a second Visual Studio process. Une fois que vous avez terminé, vous pouvez supprimer l’extension afin qu’il ne charge plus sur l’ordinateur de développement.After you are finished, you can remove the extension so that it no longer loads on the development computer.

Pour installer l'extensionTo install the extension

  1. Fermez toutes les instances de Visual Studio.Close all instances of Visual Studio.

  2. Dans le dossier de sortie pour le projet d’extension, ouvrez le .vsix fichier en double-cliquant dessus ou en ouvrant le menu contextuel, puis en choisissant ouvrir:In the build output folder for the extension project, open the .vsix file either by double-clicking it or by opening its shortcut menu and then choosing Open:

  3. Dans le le programme d’installation de Visual Studio Extension boîte de dialogue, sélectionnez l’édition de Visual Studio à laquelle vous souhaitez installer l’extension, puis choisissez le installer bouton.In the Visual Studio Extension Installer dialog box, choose the edition of Visual Studio to which you want to install the extension, and then choose the Install button.

    Visual Studio installe les fichiers d’extension %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0\Extensions\nom de l’auteur\nom de l’extension \ version.Visual Studio installs the extension files to %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0\Extensions\author name\extension name\version. Les trois derniers dossiers dans ce chemin d’accès sont construits à partir de la Author, Name, et Version éléments dans le extension.vsixmanifest fichier pour l’extension.The last three folders in this path are constructed from the Author, Name, and Version elements in the extension.vsixmanifest file for the extension.

  4. Une fois que Visual Studio installe l’extension, choisissez le fermer bouton.After Visual Studio installs the extension, choose the Close button.

Pour déboguer l’extensionTo debug the extension

  1. Démarrez Visual Studio avec des privilèges d’administrateur et ouvrez le projet d’extension.Start Visual Studio with administrator privileges and open the extension project. Les étapes suivantes font référence à cette instance de Visual Studio en tant que le tout d’abord l’instance.The following steps refer to this instance of Visual Studio as the first instance.

  2. Démarrer une autre instance de Visual Studio avec des privilèges d’administrateur.Start another instance of Visual Studio with administrator privileges. Les étapes suivantes font référence à cette instance de Visual Studio en tant que le deuxième instance.The following steps refer to this instance of Visual Studio as the second instance.

  3. Basculez vers la première instance de Visual Studio.Switch to the first instance of Visual Studio.

  4. Dans la barre de menus, choisissez déboguer, attacher au processus.On the menu bar, choose Debug, Attach to Process.

  5. Dans le processus disponibles , choisissez devenv.exe.In the Available Processes list, choose devenv.exe. Cette entrée fait référence à la deuxième instance de Visual Studio ; Il s’agit de l’instance que vous souhaitez déboguer votre extension de projet dans.This entry refers to the second instance of Visual Studio; this is the instance you want to debug your project extension in.

  6. Choisissez le attacher bouton.Choose the Attach button.

    Visual Studio exécute le projet d’extension en mode débogage.Visual Studio runs the extension project in debug mode.

  7. Basculez vers la deuxième instance de Visual Studio.Switch to the second instance of Visual Studio.

  8. Créer un nouveau projet SharePoint qui charge votre extension.Create a new SharePoint project that loads your extension. Par exemple, si vous déboguez une extension pour les éléments de projet de définition de liste, créez un définition de liste projet.For example, if you are debugging an extension for list definition project items, create a List Definition project.

  9. Exécutez les étapes requises pour tester votre code d’extension.Perform whatever steps are required to test your extension code.

  10. Lorsque vous avez fini de déboguer l’extension, fermez la deuxième instance de Visual Studio.When you are finished debugging the extension, close the second instance of Visual Studio.

Pour supprimer l’extensionTo remove the extension

  1. Dans Visual Studio, dans la barre de menus, choisissez outils, Extensions et mises à jour.In Visual Studio, on the menu bar, choose Tools, Extensions and Updates.

    La boîte de dialogue Extensions et mises à jour s’ouvre.The Extensions and Updates dialog box opens.

  2. Dans la liste des extensions, choisissez le nom de l’extension, puis le désinstallation bouton.In the list of extensions, choose the name of the extension, and then choose the Uninstall button.

  3. Dans la boîte de dialogue qui s’affiche, choisissez le Oui pour confirmer que vous souhaitez désinstaller l’extension.In the dialog box that appears, choose the Yes button to confirm that you want to uninstall the extension.

  4. Choisissez le redémarrer maintenant bouton pour terminer la désinstallation.Choose the Restart Now button to complete the uninstallation.

Déboguer des commandes SharePointDebug SharePoint commands

Si vous souhaitez déboguer une commande SharePoint qui fait partie d’une extension des outils SharePoint, vous devez attacher le débogueur à la vssphost4.exe processus.If you want to debug a SharePoint command that is part of a SharePoint tools extension, you must attach the debugger to the vssphost4.exe process. Voici le processus hôte 64 bits qui exécute les commandes SharePoint.This is the 64-bit host process that executes SharePoint commands. Pour plus d’informations sur les commandes SharePoint et vssphost4.exe, consultez appeler des modèles d’objet SharePoint.For more information about SharePoint commands and vssphost4.exe, see Call into the SharePoint object models.

Pour attacher le débogueur au processus vssphost4.exeTo attach the debugger to the vssphost4.exe process

  1. Démarrez le débogage de votre extension dans l’instance expérimentale de Visual Studio ou l’instance normale de Visual Studio en suivant les instructions ci-dessus.Start debugging your extension in the experimental instance of Visual Studio or the regular instance of Visual Studio by following the instructions above.

  2. Dans l’instance de Visual Studio dans lequel vous exécutez le débogueur, sur la barre de menus, choisissez déboguer, attacher au processus.In the instance of Visual Studio in which you are running the debugger, on the menu bar, choose Debug, Attach to Process.

  3. Dans le processus disponibles , choisissez vssphost.exe.In the Available Processes list, choose vssphost.exe.

    Note

    Si vssphost.exe n’apparaît pas dans la liste, vous devez démarrer le vssphost4.exe processus dans l’instance de Visual Studio dans lequel vous exécutez l’extension.If vssphost.exe does not appear in the list, you must start the vssphost4.exe process in the instance of Visual Studio in which you are running the extension. En règle générale, cela en effectuant une action qui oblige Visual Studio pour vous connecter au site SharePoint sur l’ordinateur de développement.Typically, you do this by performing an action that causes Visual Studio to connect to the SharePoint site on the development computer. Par exemple, Visual Studio démarre vssphost4.exe lorsque vous développez un nœud de connexion de site (nœud qui affiche une URL de site) sous le connexions SharePoint nœud dans le Explorateur de serveurs fenêtre, ou lorsque vous ajoutez certains éléments de projet SharePoint, tels que liste Instance ou récepteur d’événements éléments, à un projet SharePoint.For example, Visual Studio starts vssphost4.exe when you expand a site connection node (a node that displays a site URL) under the SharePoint Connections node in the Server Explorer window, or when you add certain SharePoint project items, such as List Instance or Event Receiver items, to a SharePoint project.

  4. Choisissez le attacher bouton.Choose the Attach button.

  5. Dans l’instance de Visual Studio est en cours de débogage, effectuez les étapes qui sont nécessaires pour exécuter votre commande.In the instance of Visual Studio that is being debugged, perform the steps that are required to execute your command.

Modifier les valeurs de Registre pour vous aider à déboguer des extensions d’outils SharePointModify registry values to help debug SharePoint tools extensions

Lorsque vous déboguez une extension des outils SharePoint dans Visual Studio, vous pouvez modifier les valeurs dans le Registre pour vous aider à résoudre les problèmes de l’extension.When you debug an extension of the SharePoint tools in Visual Studio, you can modify values in the registry to help you troubleshoot the extension. Les valeurs existent sous le HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0\SharePointTools clé.The values exist under the HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0\SharePointTools key. Ces valeurs n’existent pas par défaut.These values do not exist by default.

Pour aider à résoudre les problèmes de n’importe quelle extension des outils SharePoint, vous pouvez créer et définir la valeur EnableDiagnostics.To help troubleshoot any extension of the SharePoint tools, you can create and set the EnableDiagnostics value. Le tableau suivant décrit cette valeur.The following table describes this value.

ValueValue DescriptionDescription
EnableDiagnosticsEnableDiagnostics REG_DWORD qui spécifie si les messages de diagnostic sont affichés dans le sortie fenêtre.REG_DWORD that specifies whether diagnostic messages are displayed in the Output window.

Pour afficher les messages de diagnostic, définissez cette valeur sur 1.To display diagnostic messages, set this value to 1. Pour arrêter l’affichage des messages, définissez cette valeur sur 0, ou supprimez cette valeur.To stop displaying messages, set this value to 0 or delete this value.

Pour écrire des messages à la sortie extension des outils de fenêtre à partir de SharePoint, utilisez le service de projet SharePoint.To write messages to the Output window from a SharePoint tools extension, use the SharePoint project service. Pour plus d’informations, consultez utiliser le service de projet SharePoint.For more information, see Use the SharePoint project service.

Si votre extension inclut une commande SharePoint, vous pouvez créer et définir des valeurs supplémentaires pour aider à résoudre les problèmes de la commande.If your extension includes a SharePoint command, you can create and set additional values to help troubleshoot the command. Le tableau suivant décrit ces valeurs.The following table describes these values.

ValueValue DescriptionDescription
AttachDebuggerToHostProcessAttachDebuggerToHostProcess REG_DWORD qui spécifie s’il faut afficher une boîte de dialogue qui vous permet d’attacher le débogueur à vssphost4.exe dès qu’il démarre.REG_DWORD that specifies whether to display a dialog box that enables you to attach the debugger to vssphost4.exe as soon as it starts. Cela est utile si la commande que vous souhaitez déboguer est exécutée par vssphost.exe immédiatement après son démarrage, et il n’est pas suffisamment de temps pour attacher manuellement le débogueur avant l’exécution de la commande.This is useful if the command that you want to debug is executed by vssphost.exe immediately after it starts, and there is not enough time to manually attach the debugger before the command is executed. Pour afficher la boîte de dialogue vssphost4.exe appelle le Break méthode lorsqu’il démarre.To display the dialog box, vssphost4.exe calls the Break method when it starts.

Pour activer ce comportement, définissez cette valeur sur 1.To enable this behavior, set this value to 1. Pour désactiver ce comportement, définissez cette valeur sur 0, ou supprimez cette valeur.To turn off this behavior, set this value to 0 or delete this value.

Si vous définissez cette valeur sur 1, vous pouvez également augmenter la valeur HostProcessStartupTimeout vous-même suffisamment de temps pour attacher le débogueur avant Visual Studio attend vssphost4.exe pour signaler qu’il a démarré avec succès.If you set this value to 1, you may also want to increase the HostProcessStartupTimeout value to give yourself enough time to attach the debugger before Visual Studio expects vssphost4.exe to signal that it started successfully.
ChannelOperationTimeoutChannelOperationTimeout REG_DWORD qui spécifie la durée, en secondes, pendant laquelle Visual Studio attend une commande SharePoint à exécuter.REG_DWORD that specifies the time, in seconds, that Visual Studio waits for a SharePoint command to execute. Si la commande ne s’exécute pas dans le temps, un SharePointConnectionException est levée.If the command does not execute in time, a SharePointConnectionException is thrown.

La valeur par défaut est 120 secondes.The default is 120 seconds.
HostProcessStartupTimeoutHostProcessStartupTimeout REG_DWORD qui spécifie la durée, en secondes, que Visual Studio attend que vssphost4.exe pour signaler qu’il a démarré avec succès.REG_DWORD that specifies the time, in seconds, that Visual Studio waits for vssphost4.exe to signal that it started successfully. Si vssphost4.exe ne signale pas de démarrage réussi dans le temps, un SharePointConnectionException est levée.If vssphost4.exe does not signal a successful start in time, a SharePointConnectionException is thrown.

La valeur par défaut est de 60 secondes.The default is 60 seconds.
MaxReceivedMessageSizeMaxReceivedMessageSize REG_DWORD qui spécifie la taille maximale autorisée, en octets, des messages WCF passés entre Visual Studio et vssphost4.exe.REG_DWORD that specifies the maximum allowed size, in bytes, of WCF messages that are passed between Visual Studio and vssphost4.exe.

La valeur par défaut est 1 048 576 octets (1 Mo).The default is 1,048,576 bytes (1 MB).
MaxStringContentLengthMaxStringContentLength REG_DWORD qui spécifie la taille maximale autorisée, en octets, de chaînes qui sont passés entre Visual Studio et vssphost4.exe.REG_DWORD that specifies the maximum allowed size, in bytes, of strings that are passed between Visual Studio and vssphost4.exe.

La valeur par défaut est 1 048 576 octets (1 Mo).The default is 1,048,576 bytes (1 MB).

Voir aussiSee also