IVsUIHierarchy.GetCanonicalName(UInt32, String) 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
用于工作区持久性，例如，用于记住窗口位置。
public:
int GetCanonicalName(System::UInt32 itemid, [Runtime::InteropServices::Out] System::String ^ % pbstrName);int GetCanonicalName(unsigned int itemid, [Runtime::InteropServices::Out] std::wstring const & & pbstrName);public int GetCanonicalName (uint itemid, out string pbstrName);abstract member GetCanonicalName : uint32 * string -> intPublic Function GetCanonicalName (itemid As UInteger, ByRef pbstrName As String) As Integer参数
- itemid
- UInt32
中层次结构项的标识符。 有关值的列表 itemid ，请参阅 VSITEMID 。
- pbstrName
- String
弄指向层次结构项的规范名称的指针。
返回
如果该方法成功，则它会返回 S_OK。 如果该方法失败，则会返回错误代码。
实现
注解
COM 签名
从 vsshell：
HRESULT IVsUIHierarchy::GetCanonicalName(
[in] VSITEMID itemid,
[out] BSTR *pbstrName
);
层次结构是包含多个项的对象，但不一定包含其中每个项的对象。 因此，若要获取有关任何层次结构项的信息，需要查询该信息的层次结构对象。 项标识符 (itemid) 用于标识该查询中请求的项。 使用 GetCanonicalName 方法，将传入 itemid 并返回规范名称。 规范名称是用于区分层次结构中的特定项与层次结构中的每个其他项的唯一名称。
规范名称在环境的会话之间不会发生更改，但项标识符具有。 使用此方法可以管理工作区持久性，如记住窗口位置。
备注
环境通常调用此方法，但它可由具有层次结构对象和特定项标识符的任何人调用。
如果 ParseCanonicalName 给定项的规范名称，请使用确定项标识符 (项 ID) 。