通过

IVsHierarchy.GetCanonicalName 方法

  • 项目

返回唯一，字符串名称在层次结构中的项。用于工作区持久性，例如确保窗口位置。

命名空间：  Microsoft.VisualStudio.Shell.Interop
程序集：  Microsoft.VisualStudio.Shell.Interop（在 Microsoft.VisualStudio.Shell.Interop.dll 中）

语法

声明
Function GetCanonicalName ( _
    itemid As UInteger, _
    <OutAttribute> ByRef pbstrName As String _
) As Integer

int GetCanonicalName(
    uint itemid,
    out string pbstrName
)

参数

  • itemid
    类型：System.UInt32
    [in] 层次结构项的标识符。有关 itemid 值列表，请参见 VSITEMID。
  • pbstrName
    类型：System.String%
    [out] 对层次结构项目的规范名称的指针。

返回值

类型：System.Int32
如果方法成功，则返回 S_OK。如果失败，它会返回一个错误代码。

备注

层次结构是包含许多项目的对象，但是，不一定包含这些项目中的对象。因此，获取有关的信息任何层次结构项目，需要查询层次结构对象这些信息。项 ID (itemid) 用于标识在该查询的请求项。使用 GetCanonicalName 方法，可以在 itemid 中，而规范名称返回。规范名称是用于的唯一名称与在层次结构中的其他项目区分在层次结构的特定项。

规范名称不会更改该环境的会话之间，但是，项 ID。使用此方法控制工作区持久性，例如确保窗口位置。

说明说明

该环境通常会调用此方法，但是，它可以任何人都可以调用带层次结构对象与特定项 ID。

使用 ParseCanonicalName 确定项 ID (项 ID)，命名规范名称项目。

COM 签名

从 vsshell.idl:

HRESULT IVsHierarchy::GetCanonicalName(
   [in] VSITEMID itemid,
   [out] BSTR *pbstrName
);

.NET Framework 安全性

请参见

参考

IVsHierarchy 接口

Microsoft.VisualStudio.Shell.Interop 命名空间