在Visual C#2010中获取DTE2对象的引用

我想获得对当前解决方案的引用,在Visual Studio 2010中使用带有C#的DTE2对象。

我首先尝试了以下代码:

var dte = Marshal.GetActiveObject("VisualStudio.DTE.10.0") as EnvDTE80.DTE2; 

但是当我打开2个解决方案,并且这个代码在第一个解决方案中时,我得不到对当前解决方案的引用,而是对我加载的最后一个解决方案的引用。 我需要当前的解决方案……

在互联网上搜索,我发现以下解决方案如何从VSPackage获取当前的解决方案目录? :

 // Get an instance of the currently running Visual Studio IDE DTE dte = (DTE)GetService(typeof(DTE)); 

但是当我使用它时,我的dte对象总是为NULL。

那么如何使用C#on .net framework 4.0获取VS2010中当前的解决方案对象?

经过一番广泛的搜索和尝试后,我终于使用添加到MSDN页面的评论得到了答案: http : //msdn.microsoft.com/en-us/library/ms228755.aspx

我在我的c#项目中添加了一个静态类:

 using System; using System.Diagnostics; using System.Runtime.InteropServices; using System.Runtime.InteropServices.ComTypes; using EnvDTE80; [DllImport("ole32.dll")] private static extern void CreateBindCtx(int reserved, out IBindCtx ppbc); [DllImport("ole32.dll")] private static extern void GetRunningObjectTable(int reserved, out IRunningObjectTable prot); internal static DTE2 GetCurrent() { //rot entry for visual studio running under current process. string rotEntry = String.Format("!VisualStudio.DTE.10.0:{0}", Process.GetCurrentProcess().Id); IRunningObjectTable rot; GetRunningObjectTable(0, out rot); IEnumMoniker enumMoniker; rot.EnumRunning(out enumMoniker); enumMoniker.Reset(); IntPtr fetched = IntPtr.Zero; IMoniker[] moniker = new IMoniker[1]; while (enumMoniker.Next(1, moniker, fetched) == 0) { IBindCtx bindCtx; CreateBindCtx(0, out bindCtx); string displayName; moniker[0].GetDisplayName(bindCtx, null, out displayName); if (displayName == rotEntry) { object comObject; rot.GetObject(moniker[0], out comObject); return (EnvDTE80.DTE2)comObject; } } return null; } 

在我想要访问当前IDE的时候:

 var dte = CurrentIde.GetCurrent(); var sol = dte.Solution; 

但请记住….这段代码在调试过程中不起作用! 以字符串rotEntry开头的代码行…调用Process.GetCurrentProcess来获取当前进程的ID。

在我的插件中调试一些function时(使用MME http://mme.codeplex.com/ ),我调用了一个需要当前IDE的方法。 我使用调用addin方法的ConsoleApp来测试它。 在获取当前IDE时,当前进程不是IDE,而是ConsoleApp.vshost.exe。 所以我的代码在调试期间不起作用,但DID在构建插件并安装此插件后工作。

我觉得以下几点令人不安,所以我已经解决了这些问题并找到了适合我的解决方案:

  • GetActiveObject("VisualStudio.DTE.10.0")仅适用于第一个打开的(我猜想)Visual Studio
  • Dennis回答的internal static DTE2 GetCurrent()方法需要Visual Studio进程Id。 如果你从加载项运行代码(我认为),这很好,但在unit testing中不起作用。
  • 调试模式中的问题

我也从这里开始使用GetCurrent方法。 问题是,我不知道如何进入正确的VisualStudio进程的ProcessId(通常是多个实例正在运行)。 所以我采用的方法是获取所有VisualStudio ROT条目及其DTE2,然后将DTE2.Solution.FullName与正在执行的程序集位置进行比较(你看到更好的选择吗?)。 虽然我很乐意承认这不是一门非常精确的科学,但如果您没有相当特殊的输出路径配置,它应该可以工作。 然后我发现在调试模式下运行我的代码并访问DTE2 COM对象会引发以下exception: System.Runtime.InteropServices.COMException: Call was rejected by callee. (Exception from HRESULT: 0x80010001 (RPC_E_CALL_REJECTED)) System.Runtime.InteropServices.COMException: Call was rejected by callee. (Exception from HRESULT: 0x80010001 (RPC_E_CALL_REJECTED)) 。 但是有一种补救措施,称为MessageFilter 。 为了完整起见,我已将代码包含在底部。

包含测试方法(用法示例)的测试类,调整后的GetCurrent方法和用于字符串比较的辅助方法:

 using System; using System.Collections.Generic; using Microsoft.VisualStudio.TestTools.UnitTesting; using EnvDTE80; using EnvDTE; using System.Runtime.InteropServices; using System.Runtime.InteropServices.ComTypes; [TestClass] public class ProjectSettingsTest { ///  /// Tests that the platform for Mixed Platforms and Any CPU configurations /// is Any CPU for all projects of this solution ///  [TestMethod] public void TestReleaseBuildIsAnyCPU() { MessageFilter.Register(); DTE2 dte2 = GetCurrent(); Assert.IsNotNull(dte2); foreach (SolutionConfiguration2 config in dte2.Solution.SolutionBuild.SolutionConfigurations) { if (config.PlatformName.Contains("Mixed Platforms") || config.PlatformName.Contains("Any CPU")) { foreach (SolutionContext context in config.SolutionContexts) Assert.AreEqual("Any CPU", context.PlatformName, string.Format("{0} is configured {1} in {2}/{3}", context.ProjectName, context.PlatformName, config.PlatformName, config.Name)); } } MessageFilter.Revoke(); } [DllImport("ole32.dll")] private static extern void CreateBindCtx(int reserved, out IBindCtx ppbc); [DllImport("ole32.dll")] private static extern void GetRunningObjectTable(int reserved, out IRunningObjectTable prot); ///  /// Gets the current visual studio's solution DTE2 ///  public static DTE2 GetCurrent() { List dte2s = new List(); IRunningObjectTable rot; GetRunningObjectTable(0, out rot); IEnumMoniker enumMoniker; rot.EnumRunning(out enumMoniker); enumMoniker.Reset(); IntPtr fetched = IntPtr.Zero; IMoniker[] moniker = new IMoniker[1]; while (enumMoniker.Next(1, moniker, fetched) == 0) { IBindCtx bindCtx; CreateBindCtx(0, out bindCtx); string displayName; moniker[0].GetDisplayName(bindCtx, null, out displayName); // add all VisualStudio ROT entries to list if (displayName.StartsWith("!VisualStudio")) { object comObject; rot.GetObject(moniker[0], out comObject); dte2s.Add((DTE2)comObject); } } // get path of the executing assembly (assembly that holds this code) - you may need to adapt that to your setup string thisPath = System.Reflection.Assembly.GetExecutingAssembly().Location; // compare dte solution paths to find best match KeyValuePair maxMatch = new KeyValuePair(null, 0); foreach (DTE2 dte2 in dte2s) { int matching = GetMatchingCharsFromStart(thisPath, dte2.Solution.FullName); if (matching > maxMatch.Value) maxMatch = new KeyValuePair(dte2, matching); } return (DTE2)maxMatch.Key; } ///  /// Gets index of first non-equal char for two strings /// Not case sensitive. ///  private static int GetMatchingCharsFromStart(string a, string b) { a = (a ?? string.Empty).ToLower(); b = (b ?? string.Empty).ToLower(); int matching = 0; for (int i = 0; i < Math.Min(a.Length, b.Length); i++) { if (!char.Equals(a[i], b[i])) break; matching++; } return matching; } } 

MessageFilter类:

 ///  /// Class containing the IOleMessageFilter /// thread error-handling functions. ///  public class MessageFilter : IOleMessageFilter { // Start the filter. public static void Register() { IOleMessageFilter newFilter = new MessageFilter(); IOleMessageFilter oldFilter = null; CoRegisterMessageFilter(newFilter, out oldFilter); } // Done with the filter, close it. public static void Revoke() { IOleMessageFilter oldFilter = null; CoRegisterMessageFilter(null, out oldFilter); } // // IOleMessageFilter functions. // Handle incoming thread requests. int IOleMessageFilter.HandleInComingCall(int dwCallType, System.IntPtr hTaskCaller, int dwTickCount, System.IntPtr lpInterfaceInfo) { return 0; //Return the flag SERVERCALL_ISHANDLED. } // Thread call was rejected, so try again. int IOleMessageFilter.RetryRejectedCall(System.IntPtr hTaskCallee, int dwTickCount, int dwRejectType) { if (dwRejectType == 2) // flag = SERVERCALL_RETRYLATER. { return 99; // Retry the thread call immediately if return >=0 & <100. } return -1; // Too busy; cancel call. } int IOleMessageFilter.MessagePending(System.IntPtr hTaskCallee, int dwTickCount, int dwPendingType) { //Return the flag PENDINGMSG_WAITDEFPROCESS. return 2; } // Implement the IOleMessageFilter interface. [DllImport("Ole32.dll")] private static extern int CoRegisterMessageFilter(IOleMessageFilter newFilter, out IOleMessageFilter oldFilter); } [ComImport(), Guid("00000016-0000-0000-C000-000000000046"), InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)] interface IOleMessageFilter { [PreserveSig] int HandleInComingCall(int dwCallType, IntPtr hTaskCaller, int dwTickCount, IntPtr lpInterfaceInfo); [PreserveSig] int RetryRejectedCall(IntPtr hTaskCallee, int dwTickCount, int dwRejectType); [PreserveSig] int MessagePending(IntPtr hTaskCallee, int dwTickCount, int dwPendingType); } 

我知道这是一个旧线程,但我们需要在多个Visual Studio版本中使用此代码。 我们调整了代码如下:

 string processID = Process.GetCurrentProcess().Id.ToString(); if (displayName.StartsWith("!VisualStudio.DTE.", StringComparison.OrdinalIgnoreCase) && displayName.EndsWith(processID)) 

对于任何有兴趣使用F#进行此操作的人来说,这里主要是完全转换(目前设置为在linqpad中运行):

 open System; open System.Runtime.InteropServices; open System.Runtime.InteropServices.ComTypes; open EnvDTE; open System.Diagnostics; //http://stackoverflow.com/questions/10864595/getting-the-current-envdte-or-iserviceprovider-when-not-coding-an-addin //http://stackoverflow.com/questions/6558789/how-to-convert-out-ref-extern-parameters-to-f //http://stackoverflow.com/questions/1689460/f-syntax-for-p-invoke-signature-using-marshalas [] extern int CreateBindCtx(System.IntPtr inRef, IBindCtx& outParentRef); [] extern int GetRunningObjectTable(System.IntPtr inRef, IRunningObjectTable& outParentRef); //let dte = System.Runtime.InteropServices.Marshal.GetActiveObject("VisualStudio.DTE.12.0") :?> EnvDTE80.DTE2 let comName="VisualStudio.DTE.12.0" let rotEntry = "!"+comName //let mutable rot:IRunningObjectTable =null let rot= let mutable result:IRunningObjectTable = null GetRunningObjectTable(nativeint 0, &result) |> ignore result let mutable enumMoniker:IEnumMoniker = null rot.EnumRunning (&enumMoniker) enumMoniker.Reset() |> ignore let mutable fetched = IntPtr.Zero let mutable moniker:IMoniker[] = Array.zeroCreate 1 //http://msdn.microsoft.com/en-us/library/dd233214.aspx let matches = seq { while enumMoniker.Next(1, moniker, fetched) = 0 do "looping" |> Dump let mutable bindCtx:IBindCtx = null CreateBindCtx(nativeint 0, &bindCtx) |> ignore let mutable displayName:string = null moniker.[0].GetDisplayName(bindCtx,null, &displayName) displayName |> Dump if displayName.StartsWith(rotEntry) then let mutable comObject = null rot.GetObject(moniker.[0], &comObject) |> ignore let dte = comObject:?>EnvDTE80.DTE2 yield displayName,bindCtx,comObject,dte.FullName, dte } matches |> Dump 

我已经完成了一个更加舒适的完美解决方案(没有火箭科学)。 这个从Visual Studio 20到10的工作方式可以找到独立于VS版本的DTE。

 using System; using System.Diagnostics; using System.Runtime.InteropServices; using System.Runtime.InteropServices.ComTypes; using EnvDTE80; namespace Fortrus.Metadata { ///  /// This class takes care of fetching the correct DTE instance for the current process /// The current implementation works it way down from Visual Studio version 20 to 10 so /// it should be farely version independent ///  public static class Processes { [DllImport("ole32.dll")] private static extern void CreateBindCtx(int reserved, out IBindCtx ppbc); [DllImport("ole32.dll")] private static extern void GetRunningObjectTable(int reserved, out IRunningObjectTable prot); private const int m_MaxVersion = 20; private const int m_MinVersion = 10; internal static DTE2 GetDTE() { DTE2 dte = null; for (int version = m_MaxVersion; version >= m_MinVersion; version--) { string versionString = string.Format("VisualStudio.DTE.{0}.0", version); dte = Processes.GetCurrent(versionString); if (dte != null) { return dte; } } throw new Exception(string.Format("Can not get DTE object tried versions {0} through {1}", m_MaxVersion, m_MinVersion)); } ///  /// When multiple instances of Visual Studio are running there also multiple DTE available /// The method below takes care of selecting the right DTE for the current process ///  ///  /// Found this at: http://stackoverflow.com/questions/4724381/get-the-reference-of-the-dte2-object-in-visual-c-sharp-2010/27057854#27057854 ///  private static DTE2 GetCurrent(string versionString) { //rot entry for visual studio running under current process. string rotEntry = String.Format("!{0}:{1}", versionString, Process.GetCurrentProcess().Id); IRunningObjectTable rot; GetRunningObjectTable(0, out rot); IEnumMoniker enumMoniker; rot.EnumRunning(out enumMoniker); enumMoniker.Reset(); IntPtr fetched = IntPtr.Zero; IMoniker[] moniker = new IMoniker[1]; while (enumMoniker.Next(1, moniker, fetched) == 0) { IBindCtx bindCtx; CreateBindCtx(0, out bindCtx); string displayName; moniker[0].GetDisplayName(bindCtx, null, out displayName); if (displayName == rotEntry) { object comObject; rot.GetObject(moniker[0], out comObject); return (EnvDTE80.DTE2)comObject; } } return null; } } }