IVsHierarchy.GetCanonicalName(UInt32, String) Метод

Определение

Возвращает уникальное строковое имя для элемента в иерархии. Используется для сохранения рабочей области, например запоминания позиций окон.

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 -> int
Public Function GetCanonicalName (itemid As UInteger, ByRef pbstrName As String) As Integer

Параметры

itemid
UInt32

[in] Идентификатор элемента иерархии. Список значений itemid см. в VSITEMID.

pbstrName
String

[out] Указатель на каноническое имя элемента иерархии.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Иерархия — это объект, который содержит много элементов, но не обязательно содержит объект для каждого из этих элементов. Таким же, чтобы получить сведения о любом из элементов иерархии, необходимо запросить эти сведения у объекта иерархии. Идентификатор элемента ( itemid ) используется для идентификации запрошенного элемента в этом запросе. С помощью GetCanonicalName метода возвращается идентификатор itemId и каноническое имя. Каноническое имя — это уникальное имя, используемое для различения конкретного элемента в иерархии от каждого другого элемента в иерархии.

Канонические имена не меняются между сеансами среды, но идентификаторы элементов имеют значение. Этот метод используется для управления сохраняемостью рабочей области, например для запоминания позиций окна.

Примечание

Среда обычно вызывает этот метод, но может быть вызвана любым объектом иерархии и идентификатором определенного элемента.

Используйте ParseCanonicalName для определения идентификатора элемента (идентификатора элемента), учитывая каноническое имя элемента.

Подпись COM

Из всшелл. IDL:

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

Применяется к