在Visual C＃2010中獲取DTE2對象的引用

Question

我想在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中當前的解決方案對象？

Answer 1

經過一番廣泛的搜索和嘗試后，我終於使用添加到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;

但請記住....這段代碼在調試過程中不起作用！ 以string rotEntry ...開頭的代碼行調用Process.GetCurrentProcess來獲取當前進程的ID。

在我的插件中調試一些功能時（使用MME http://mme.codeplex.com/ ），我調用了一個需要當前IDE的方法。 我用調用addin方法的ConsoleApp測試它。 在獲取當前IDE時，當前進程不是IDE，而是ConsoleApp.vshost.exe。 所以我的代碼在調試期間不起作用，但DID在構建插件並安裝此插件后工作。

Answer 2

我覺得以下幾點令人不安，所以我已經解決了這些問題並找到了適合我的解決方案：

• GetActiveObject("VisualStudio.DTE.10.0")僅適用於第一個打開的（我猜想）Visual Studio
• Dennis回答的internal static DTE2 GetCurrent()方法需要Visual Studio進程Id。 如果你從加載項運行代碼（我認為），這很好，但在單元測試中不起作用。
• 調試模式中的問題

我也從這里開始使用GetCurrent方法。 問題是，我不知道如何進入正確的VisualStudio進程的ProcessId（通常是多個實例正在運行）。 所以我采用的方法是獲取所有VisualStudio ROT條目及其DTE2，然后將DTE2.Solution.FullName與正在執行的程序集位置進行比較（你看到了更好的選擇嗎？）。 雖然我很樂意承認這不是一門非常精確的科學，但如果您沒有相當特殊的輸出路徑配置，它應該可以工作。 然后我發現在調試模式下運行我的代碼並訪問DTE2 COM對象會引發以下異常： 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
{
    /// <summary>
    /// Tests that the platform for Mixed Platforms and Any CPU configurations 
    /// is Any CPU for all projects of this solution
    /// </summary>
    [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);

    /// <summary>
    /// Gets the current visual studio's solution DTE2
    /// </summary>
    public static DTE2 GetCurrent()
    {
        List<DTE2> dte2s = new List<DTE2>();

        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<DTE2, int> maxMatch = new KeyValuePair<DTE2, int>(null, 0);
        foreach (DTE2 dte2 in dte2s)
        {
            int matching = GetMatchingCharsFromStart(thisPath, dte2.Solution.FullName);
            if (matching > maxMatch.Value)
                maxMatch = new KeyValuePair<DTE2, int>(dte2, matching);
        }

        return (DTE2)maxMatch.Key;
    }

    /// <summary>
    /// Gets index of first non-equal char for two strings
    /// Not case sensitive.
    /// </summary>
    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類：

/// <summary>
/// Class containing the IOleMessageFilter
/// thread error-handling functions.
/// </summary>
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);
}

Answer 3

我知道這是一個舊線程，但我們需要在多個Visual Studio版本中使用此代碼。 我們調整了代碼如下：

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

Answer 4

對於任何有興趣使用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

[<System.Runtime.InteropServices.DllImport("ole32.dll")>] 
extern int CreateBindCtx(System.IntPtr inRef, IBindCtx& outParentRef);
[<System.Runtime.InteropServices.DllImport("ole32.dll")>]
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

Answer 5

我已經完成了一個更加舒適的完美解決方案（沒有火箭科學）。 這個從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
{
    /// <summary>
    /// 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
    /// </summary>
    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));
        }

        /// <summary>
        /// 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
        /// </summary>
        /// <remarks>
        /// Found this at: http://stackoverflow.com/questions/4724381/get-the-reference-of-the-dte2-object-in-visual-c-sharp-2010/27057854#27057854
        /// </remarks>
        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;
        }
    }
}